solstice-receiver.5 (4605B)
1 .\" Copyright (C) 2016-2018 CNRS, 2018-2019 |Meso|Star> 2 .\" 3 .\" This is free documentation: you can redistribute it and/or modify 4 .\" it under the terms of the GNU General Public License as published by 5 .\" the Free Software Foundation, either version 3 of the License, or 6 .\" (at your option) any later version. 7 .\" 8 .\" This manual is distributed in the hope that it will be useful, 9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of 10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 .\" GNU General Public License for more details. 12 .\" 13 .\" You should have received a copy of the GNU General Public License 14 .\" along with this program. If not, see <http://www.gnu.org/licenses/>. 15 .\" 16 .Dd $Mdocdate$ 17 .Dt SOLSTICE-RECEIVER 5 18 .Os 19 .Sh NAME 20 .Nm solstice-receiver 21 .Nd declare solar-plant receivers for solstice 22 .Sh DESCRIPTION 23 The 24 .Nm 25 format is used by 26 .Xr solstice 1 27 to declare which geometric entities defined in a 28 .Xr solstice-input 5 29 file act as receivers. 30 For each receiver, 31 .Xr solstice 1 32 computes its total intercepted power, associated losses, and efficiency. 33 Refer to 34 .Xr solstice-output 5 35 for details on the per-receiver data produced by 36 .Xr solstice 1 . 37 Defining receivers separately from the solar plant allows the same 38 .Xr solstice-input 5 39 file to be reused across multiple simulations with different receiver 40 configurations. 41 For example, you can create a dedicated 42 .Nm 43 file that designates certain primary reflectors as receivers to investigate 44 unexpected behaviour observed in a prior simulation. 45 .Pp 46 The 47 .Nm 48 format follows the YAML 1.1 data serialization standard 49 .Po 50 see 51 .Sx NOTES , 52 reference 1 53 .Pc . 54 Provided the file conforms to the 55 .Nm 56 semantic, receivers can be described by using the whole YAML 1.1 57 functionalities including compact notation and data tagging. 58 .Pp 59 A receiver is identified by its 60 .Em name , 61 which must be a valid 62 .Em entity-identifier 63 as defined in 64 .Xr solstice-input 5 . 65 This identifier must refer to a geometric entity, not a pivot or an empty 66 entity. 67 The side of the geometry to be tracked is specified by the 68 .Em side 69 attribute. 70 Both the front and back sides of a geometry can be considered by setting 71 .Em side 72 to 73 .Cm FRONT_AND_BACK . 74 See 75 .Xr solstice-input 5 76 for details on which side of a geometry is considered front-facing or 77 back-facing. 78 .Pp 79 If the optional 80 .Em per_primitive 81 flag is enabled, 82 .Xr solstice 1 83 estimates the flux density for each triangle of the receiver and uses this data 84 to generate a receiver map as described in 85 .Xr solstice-output 5 . 86 The 87 .Em per_primitive 88 flag accepts the values 89 .Cm INCOMING , 90 .Cm ABSORBED , 91 or 92 .Cm INCOMING_AND_ABSORBED 93 to produce the incoming flux density map, the absorbed flux density map, or 94 both, respectively. 95 .Sh GRAMMAR 96 .Bd -literal 97 <receivers-list> ::= - <receiver> 98 [ - <receiver> ... ] 99 100 <receiver> ::= name: <entity-identifier> 101 side: <side-identifier> 102 [ per_primitive: <per-primitive-mode> ] # Default: NONE 103 104 <side-identifier> ::= FRONT 105 | BACK 106 | FRONT_AND_BACK 107 108 <per-primitive-mode> ::= NONE 109 | INCOMING 110 | ABSORBED 111 | INCOMING_AND_ABSORBED 112 113 <entity-identifier> # Defined in solstice-input(5) 114 .Ed 115 .Sh EXAMPLES 116 Designate both the front and back sides of the entity 117 .Cm small_square 118 as receivers, and enable per-triangle absorbed flux density computation for each 119 side: 120 .Bd -literal 121 - name: small_square 122 side: FRONT_AND_BACK 123 per_primitive: ABSORBED 124 .Ed 125 .Pp 126 Declare the front side of three reflectors as receivers using YAML compact 127 notation: 128 .Bd -literal 129 - {name: H1.heliostat.reflector, side: FRONT} 130 - {name: H4.heliostat.reflector, side: FRONT} 131 - {name: H7.heliostat.reflector, side: FRONT} 132 .Ed 133 .Pp 134 Designate the back side of 135 .Cm receiver 136 as a receiver with an incoming flux density map, and make the front side of the 137 reflector named 138 .Cm LFR0.pivot.reflector 139 a receiver: 140 .Bd -literal 141 - {name: receiver, side: BACK, per_primitive: INCOMING} 142 - {name: LFR0.pivot.reflector, side: FRONT} 143 .Ed 144 .Sh NOTES 145 .Bl -enum 146 .It 147 YAML Ain't Markup Language \(em 148 .Lk http://yaml.org 149 .El 150 .Sh SEE ALSO 151 .Xr solstice 1 , 152 .Xr solstice-input 5 , 153 .Xr solstice-output 5 154 .Sh HISTORY 155 .Nm 156 was initially developed with funding from the 157 .Em SOLSTICE LabEx 158 .Pq Laboratory of Excellence , 159 in collaboration with the PROMES Laboratory of the 160 French National Centre for Scientific Research 161 .Pq CNRS . 162 .Sh AUTHORS 163 .Nm 164 was written and is maintained by 165 .An |M\['e]so|Star> Aq Mt contact@meso-star.com .