Changeset 714 for XIOS/trunk/doc/XIOS_reference_guide.lyx
- Timestamp:
- 10/01/15 17:04:42 (9 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
XIOS/trunk/doc/XIOS_reference_guide.lyx
- Property svn:executable deleted
r559 r714 1249 1249 1250 1250 \begin_layout Standard 1251 Define the level values of thevertical axis.1251 Define the value of each level of a vertical axis. 1252 1252 The size of the array must be equal to the 1253 1253 \begin_inset Flex Strong … … 1269 1269 \end_layout 1270 1270 1271 \end_inset 1272 1273 . 1274 \end_layout 1275 1276 \begin_layout Subsection* 1277 bounds: 1278 \begin_inset Flex Emph 1279 status collapsed 1280 1281 \begin_layout Plain Layout 1282 2D-array of double 1283 \end_layout 1284 1285 \end_inset 1286 1287 1288 \end_layout 1289 1290 \begin_layout Standard 1291 Fortran: 1292 \end_layout 1293 1294 \begin_layout LyX-Code 1295 DOUBLE PRECISION :: value(:,:) 1296 \end_layout 1297 1298 \begin_layout Standard 1299 Define the boundaries of each level of a the vertical axis. 1300 The dimensions of the array must be 1301 \begin_inset Formula $2\times\textbf{size}$ 1271 1302 \end_inset 1272 1303 … … 2091 2122 2092 2123 attribute must also be defined. 2124 This attribute is optional. 2125 \end_layout 2126 2127 \begin_layout Subsection* 2128 area: 2129 \emph on 2130 2D-array of double 2131 \end_layout 2132 2133 \begin_layout Standard 2134 Fortran: 2135 \end_layout 2136 2137 \begin_layout LyX-Code 2138 DOUBLE PRECISION :: area(:,:) 2139 \end_layout 2140 2141 \begin_layout Standard 2142 Area of the cells. 2143 The size of the array must be 2144 \begin_inset Flex Strong 2145 status collapsed 2146 2147 \begin_layout Plain Layout 2148 ni 2149 \begin_inset Formula $\times$ 2150 \end_inset 2151 2152 nj 2153 \end_layout 2154 2155 \end_inset 2156 2157 . 2093 2158 This attribute is optional. 2094 2159 \end_layout … … 2903 2968 2904 2969 \begin_layout Subsection* 2970 read_access: 2971 \emph on 2972 bool 2973 \end_layout 2974 2975 \begin_layout Standard 2976 Fortran: 2977 \end_layout 2978 2979 \begin_layout LyX-Code 2980 LOGICAL :: read_access 2981 \end_layout 2982 2983 \begin_layout Standard 2984 Define whether a field can be read from the model or not. 2985 This attribute is optional, the default value is 2986 \begin_inset Flex Strong 2987 status collapsed 2988 2989 \begin_layout Plain Layout 2990 false 2991 \end_layout 2992 2993 \end_inset 2994 2995 . 2996 Note that for fields belonging to a file in 2997 \series bold 2998 \emph on 2999 read 3000 \series default 3001 \emph default 3002 3003 \series bold 3004 mode 3005 \series default 3006 , this attribute is always 3007 \series bold 3008 true 3009 \series default 3010 . 3011 \end_layout 3012 3013 \begin_layout Subsection* 2905 3014 field_ref: 2906 3015 \emph on … … 3028 3137 3029 3138 \begin_layout Standard 3030 Define the value for the missing data of a field. 3139 Define the value which should be used in place of the missing data of a 3140 field. 3031 3141 This attribute is optional. 3032 The default value is 3033 \begin_inset Flex Strong 3034 status collapsed 3035 3036 \begin_layout Plain Layout 3037 0 3038 \end_layout 3039 3040 \end_inset 3041 3042 . 3142 If no value was defined, the missing data will be replaced by uninitialized 3143 values which can lead to undefined behaviors. 3043 3144 \end_layout 3044 3145 … … 3196 3297 \end_layout 3197 3298 3299 \begin_layout Subsection* 3300 compression_level: 3301 \emph on 3302 integer 3303 \end_layout 3304 3305 \begin_layout Standard 3306 Fortran: 3307 \end_layout 3308 3309 \begin_layout LyX-Code 3310 INTEGER :: compression_level 3311 \end_layout 3312 3313 \begin_layout Standard 3314 Define whether the field should be compressed using NetCDF-4 built-in compressio 3315 n. 3316 The compression level must range from 0 to 9. 3317 An higher compression level means a better compression at the cost of using 3318 more processing power. 3319 This attribute is optional, the default value is inherited from the file 3320 attribute 3321 \series bold 3322 compression_level 3323 \series default 3324 . 3325 \end_layout 3326 3327 \begin_layout Subsection* 3328 indexed_output: 3329 \emph on 3330 bool 3331 \end_layout 3332 3333 \begin_layout Standard 3334 Fortran: 3335 \end_layout 3336 3337 \begin_layout LyX-Code 3338 LOGICAL :: indexed_output 3339 \end_layout 3340 3341 \begin_layout Standard 3342 Define whether the field data must be outputted as an indexed grid instead 3343 of a full grid whenever possible. 3344 This attribute is optional, the default value is 3345 \series bold 3346 \emph on 3347 false 3348 \series default 3349 \emph default 3350 . 3351 \end_layout 3352 3353 \begin_layout Subsection* 3354 ts_enabled: 3355 \emph on 3356 bool 3357 \end_layout 3358 3359 \begin_layout Standard 3360 Fortran: 3361 \end_layout 3362 3363 \begin_layout LyX-Code 3364 LOGICAL :: ts_enabled 3365 \end_layout 3366 3367 \begin_layout Standard 3368 Define whether the field can be outputted as a timeserie if requested. 3369 This attribute is optional, the default value is 3370 \series bold 3371 \emph on 3372 false 3373 \series default 3374 \emph default 3375 . 3376 \end_layout 3377 3378 \begin_layout Subsection* 3379 ts_split_freq: 3380 \emph on 3381 duration 3382 \end_layout 3383 3384 \begin_layout Standard 3385 Fortran: 3386 \end_layout 3387 3388 \begin_layout LyX-Code 3389 TYPE(xios_duration) :: ts_split_freq 3390 \end_layout 3391 3392 \begin_layout Standard 3393 Define the splitting frequency that should be used for the timeserie if 3394 it has been requested. 3395 This attribute is optional, by default this value is inherited from the 3396 file 3397 \series bold 3398 split_freq 3399 \series default 3400 . 3401 \end_layout 3402 3198 3403 \begin_layout Section 3199 3404 Variable attribute reference … … 3227 3432 of the variable as it will appear in an output file. 3228 3433 This attribute is optional. 3434 If not present, the 3435 \begin_inset Flex Strong 3436 status collapsed 3437 3438 \begin_layout Plain Layout 3439 id 3440 \end_layout 3441 3442 \end_inset 3443 3444 will be used instead. 3229 3445 \end_layout 3230 3446 … … 3267 3483 \emph default 3268 3484 . 3269 This attribute is optional.3485 This attribute is mandatory. 3270 3486 \end_layout 3271 3487 … … 3289 3505 3290 3506 \begin_layout Standard 3291 Define the name of the outputfile.3507 Define the name of the file. 3292 3508 This attribute is mandatory. 3293 3509 \end_layout … … 3308 3524 3309 3525 \begin_layout Standard 3310 Define a suffix to add to the name of the outputfile.3526 Define a suffix to add to the name of the file. 3311 3527 This attribute is optional. 3312 3528 \end_layout … … 3328 3544 \begin_layout Standard 3329 3545 For multiple_file, define the minimum digits composing the suffix defining 3330 the rank of the server, which will be happened to the name of the output 3331 file. 3546 the rank of the server, which will be happened to the name of the file. 3332 3547 This attribute is optional and the default value is 3333 3548 \begin_inset Flex Strong … … 3565 3780 3566 3781 \begin_layout Standard 3567 Define if a file must be outputor not.3782 Define if a file must be written/read or not. 3568 3783 This attribute is optional, the default value is 3569 3784 \begin_inset Flex Strong … … 3582 3797 type: 3583 3798 \emph on 3584 enumeration { one_file, multiple_file} 3799 mode { read, write } 3800 \end_layout 3801 3802 \begin_layout Standard 3803 Fortran: 3804 \end_layout 3805 3806 \begin_layout LyX-Code 3807 CHARACTER(LEN=*) :: mode 3808 \end_layout 3809 3810 \begin_layout Standard 3811 Define whether the file will be read or written. 3812 This attribute is optional, the default value is 3813 \begin_inset Flex Strong 3814 status collapsed 3815 3816 \begin_layout Plain Layout 3817 write 3818 \end_layout 3819 3820 \end_inset 3821 3822 . 3823 \end_layout 3824 3825 \begin_layout Subsection* 3826 type: 3827 \emph on 3828 enumeration { one_file, multiple_file } 3585 3829 \end_layout 3586 3830 … … 3594 3838 3595 3839 \begin_layout Standard 3596 Define the type of the outputfile:3840 Define the type of the file: 3597 3841 \begin_inset Flex Strong 3598 3842 status collapsed … … 3625 3869 format: 3626 3870 \emph on 3627 enumeration { netcdf4, netcdf4_classic }3871 enumeration { netcdf4, netcdf4_classic } 3628 3872 \end_layout 3629 3873 … … 3637 3881 3638 3882 \begin_layout Standard 3639 Define the format of the outputfile:3883 Define the format of the file: 3640 3884 \begin_inset Flex Strong 3641 3885 status collapsed … … 3765 4009 3766 4010 . 4011 \end_layout 4012 4013 \begin_layout Subsection* 4014 compression_level: 4015 \emph on 4016 integer 4017 \end_layout 4018 4019 \begin_layout Standard 4020 Fortran: 4021 \end_layout 4022 4023 \begin_layout LyX-Code 4024 INTEGER :: compression_level 4025 \end_layout 4026 4027 \begin_layout Standard 4028 Define whether the fields should be compressed using NetCDF-4 built-in compressi 4029 on by default. 4030 The compression level must range from 0 to 9. 4031 An higher compression level means a better compression at the cost of using 4032 more processing power. 4033 This attribute is optional, the default value is 4034 \begin_inset Flex Strong 4035 status collapsed 4036 4037 \begin_layout Plain Layout 4038 4039 \emph on 4040 0 4041 \end_layout 4042 4043 \end_inset 4044 4045 (no compression). 4046 \end_layout 4047 4048 \begin_layout Subsection* 4049 time_counter: 4050 \emph on 4051 enumeration { centered, instant, record, none } 4052 \end_layout 4053 4054 \begin_layout Standard 4055 Fortran: 4056 \end_layout 4057 4058 \begin_layout LyX-Code 4059 CHARACTER(LEN=*) :: time_counter 4060 \end_layout 4061 4062 \begin_layout Standard 4063 Define how the 4064 \begin_inset Quotes eld 4065 \end_inset 4066 4067 time_counter 4068 \begin_inset Quotes erd 4069 \end_inset 4070 4071 variable will be outputted: 4072 \end_layout 4073 4074 \begin_layout Itemize 4075 4076 \series bold 4077 \emph on 4078 centered 4079 \series default 4080 \emph default 4081 : use centered times 4082 \end_layout 4083 4084 \begin_layout Itemize 4085 4086 \series bold 4087 \emph on 4088 instant 4089 \series default 4090 \emph default 4091 : use instant times 4092 \end_layout 4093 4094 \begin_layout Itemize 4095 4096 \series bold 4097 \emph on 4098 record 4099 \series default 4100 \emph default 4101 : use record indexes 4102 \end_layout 4103 4104 \begin_layout Itemize 4105 4106 \series bold 4107 \emph on 4108 none 4109 \series default 4110 \emph default 4111 : do not output the variable. 4112 \end_layout 4113 4114 \begin_layout Standard 4115 This attribute is optional, the default value is 4116 \series bold 4117 \emph on 4118 centered 4119 \series default 4120 \emph default 4121 . 4122 \end_layout 4123 4124 \begin_layout Subsection* 4125 timeseries: 4126 \emph on 4127 enumeration { none, only, both, exclusive } 4128 \end_layout 4129 4130 \begin_layout Standard 4131 Fortran: 4132 \end_layout 4133 4134 \begin_layout LyX-Code 4135 CHARACTER(LEN=*) :: time_counter 4136 \end_layout 4137 4138 \begin_layout Standard 4139 Define whether the timeseries must be outputted: 4140 \end_layout 4141 4142 \begin_layout Itemize 4143 4144 \series bold 4145 \emph on 4146 none 4147 \series default 4148 \emph default 4149 : no timeseries are outputted, only the regular file 4150 \end_layout 4151 4152 \begin_layout Itemize 4153 4154 \series bold 4155 \emph on 4156 only 4157 \series default 4158 \emph default 4159 : only the timeseries are outputted, the regular file is not created 4160 \end_layout 4161 4162 \begin_layout Itemize 4163 4164 \series bold 4165 \emph on 4166 both 4167 \series default 4168 \emph default 4169 : both the timeseries and the regular file are outputted. 4170 \end_layout 4171 4172 \begin_layout Itemize 4173 4174 \series bold 4175 \emph on 4176 exclusive 4177 \series default 4178 \emph default 4179 : the timeseries are outputted and a regular file is created with only the 4180 fields which were not marked for output as a timeserie (if any). 4181 \end_layout 4182 4183 \begin_layout Standard 4184 This attribute is optional, the default value is 4185 \series bold 4186 \emph on 4187 none 4188 \series default 4189 \emph default 4190 . 4191 \end_layout 4192 4193 \begin_layout Subsection* 4194 ts_prefix: 4195 \emph on 4196 string 4197 \end_layout 4198 4199 \begin_layout Standard 4200 Fortran: 4201 \end_layout 4202 4203 \begin_layout LyX-Code 4204 CHARACTER(LEN=*) :: ts_prefix 4205 \end_layout 4206 4207 \begin_layout Standard 4208 Define the prefix to use for the name of the timeseries files. 4209 This attribute is optional, by default the file 4210 \series bold 4211 name 4212 \series default 4213 will be used. 3767 4214 \end_layout 3768 4215
Note: See TracChangeset
for help on using the changeset viewer.