source: XIOS/trunk/doc/inputs/reference/Transformations.lyx @ 1084

Last change on this file since 1084 was 1084, checked in by mhnguyen, 4 years ago

Update user guide and reference guide

File size: 20.5 KB
Line 
1#LyX 2.2 created this file. For more info see http://www.lyx.org/
2\lyxformat 508
3\begin_document
4\begin_header
5\save_transient_properties true
6\origin unavailable
7\textclass article
8\use_default_options true
9\maintain_unincluded_children false
10\language english
11\language_package default
12\inputencoding auto
13\fontencoding global
14\font_roman "default" "default"
15\font_sans "default" "default"
16\font_typewriter "default" "default"
17\font_math "auto" "auto"
18\font_default_family default
19\use_non_tex_fonts false
20\font_sc false
21\font_osf false
22\font_sf_scale 100 100
23\font_tt_scale 100 100
24\graphics default
25\default_output_format default
26\output_sync 0
27\bibtex_command default
28\index_command default
29\paperfontsize default
30\use_hyperref false
31\papersize default
32\use_geometry false
33\use_package amsmath 1
34\use_package amssymb 1
35\use_package cancel 1
36\use_package esint 1
37\use_package mathdots 1
38\use_package mathtools 1
39\use_package mhchem 1
40\use_package stackrel 1
41\use_package stmaryrd 1
42\use_package undertilde 1
43\cite_engine basic
44\cite_engine_type default
45\biblio_style plain
46\use_bibtopic false
47\use_indices false
48\paperorientation portrait
49\suppress_date false
50\justification true
51\use_refstyle 1
52\index Index
53\shortcut idx
54\color #008000
55\end_index
56\secnumdepth 3
57\tocdepth 3
58\paragraph_separation indent
59\paragraph_indentation default
60\quotes_language english
61\papercolumns 1
62\papersides 1
63\paperpagestyle default
64\tracking_changes false
65\output_changes false
66\html_math_output 0
67\html_css_as_file 0
68\html_be_strict false
69\end_header
70
71\begin_body
72
73\begin_layout Section
74Scalar transformation attribute reference
75\end_layout
76
77\begin_layout Subsection
78reduce_domain
79\end_layout
80
81\begin_layout Standard
82Reduce a domain into a scalar.
83\end_layout
84
85\begin_layout Subsection*
86operation:
87\emph on
88enumeration { min, max, sum, average }
89\end_layout
90
91\begin_layout Standard
92Fortran:
93\end_layout
94
95\begin_layout LyX-Code
96CHARACTER(LEN=*) :: operation
97\end_layout
98
99\begin_layout Standard
100Define the reduction operation can be done.
101 This attribute is mandatory
102\end_layout
103
104\begin_layout Subsection
105reduce_axis
106\end_layout
107
108\begin_layout Standard
109Reduce an axis into a scalar.
110\end_layout
111
112\begin_layout Subsection*
113operation:
114\emph on
115enumeration { min, max, sum, average }
116\end_layout
117
118\begin_layout Standard
119Fortran:
120\end_layout
121
122\begin_layout LyX-Code
123CHARACTER(LEN=*) :: operation
124\end_layout
125
126\begin_layout Standard
127Define the reduction operation can be done.
128 This attribute is mandatory
129\end_layout
130
131\begin_layout Subsection
132extract_axis
133\end_layout
134
135\begin_layout Standard
136Extract a point on an axis into a scalar
137\end_layout
138
139\begin_layout Subsection*
140position:
141\begin_inset Flex Emph
142status collapsed
143
144\begin_layout Plain Layout
145integer
146\end_layout
147
148\end_inset
149
150
151\end_layout
152
153\begin_layout Standard
154Fortran:
155\end_layout
156
157\begin_layout LyX-Code
158INTEGER :: position
159\end_layout
160
161\begin_layout Standard
162Position on the axis where the extraction is done.
163 This attribute is mandatory.
164\end_layout
165
166\begin_layout Section
167Axis transformation attribute reference
168\end_layout
169
170\begin_layout Subsection
171interpolate_axis
172\end_layout
173
174\begin_layout Standard
175Interpolate an axis into another one.
176\end_layout
177
178\begin_layout Subsection*
179type:
180\emph on
181string
182\end_layout
183
184\begin_layout Standard
185Fortran:
186\end_layout
187
188\begin_layout LyX-Code
189CHARACTER(LEN=*) :: type
190\end_layout
191
192\begin_layout Standard
193Define the type of interpolation on an axis.
194 This attribute is optional.
195 Default type is Lagrange
196\end_layout
197
198\begin_layout Subsection*
199order:
200\emph on
201integer
202\end_layout
203
204\begin_layout Standard
205Fortran:
206\end_layout
207
208\begin_layout LyX-Code
209INTEGER :: order
210\end_layout
211
212\begin_layout Standard
213Define a order of interpolation.
214 This attribute is optional.
215 The default value is 2.
216\end_layout
217
218\begin_layout Subsection*
219coordinate:
220\emph on
221string
222\end_layout
223
224\begin_layout Standard
225Fortran:
226\end_layout
227
228\begin_layout LyX-Code
229CHARACTER(LEN=*) :: coordinate
230\end_layout
231
232\begin_layout Standard
233Define the coordinate from which we do interpolation.
234 This coordinate should be a 3D field which is on the grid containing the
235 interpolating axis.
236 This attribute is optional.
237 
238\end_layout
239
240\begin_layout Subsection
241inverse_axis
242\end_layout
243
244\begin_layout Standard
245Turn an axis into another axis whose values are inversed from the original
246 one
247\end_layout
248
249\begin_layout Subsection
250zoom_axis
251\end_layout
252
253\begin_layout Standard
254Zoom into a potion of an axis
255\end_layout
256
257\begin_layout Subsection*
258begin:
259\begin_inset Flex Emph
260status collapsed
261
262\begin_layout Plain Layout
263integer
264\end_layout
265
266\end_inset
267
268
269\end_layout
270
271\begin_layout Standard
272Fortran:
273\end_layout
274
275\begin_layout LyX-Code
276INTEGER :: begin
277\end_layout
278
279\begin_layout Standard
280Define the beginning index of the zoomed region on global axis.
281 This attribute is optional.
282 This must be an integer between
283\begin_inset Flex Strong
284status collapsed
285
286\begin_layout Plain Layout
2870
288\end_layout
289
290\end_inset
291
292 and
293\begin_inset Flex Strong
294status collapsed
295
296\begin_layout Plain Layout
297ni_glo-1
298\end_layout
299
300\end_inset
301
302 of associated axis.
303 If not specified the default value is
304\begin_inset Flex Strong
305status collapsed
306
307\begin_layout Plain Layout
3080
309\end_layout
310
311\end_inset
312
313.
314\end_layout
315
316\begin_layout Subsection*
317n:
318\begin_inset Flex Emph
319status collapsed
320
321\begin_layout Plain Layout
322integer
323\end_layout
324
325\end_inset
326
327
328\end_layout
329
330\begin_layout Standard
331Fortran:
332\end_layout
333
334\begin_layout LyX-Code
335INTEGER :: n
336\end_layout
337
338\begin_layout Standard
339Define the size of zoomed region on global axis.
340 This attribute is optional.
341 This must be an integer between
342\begin_inset Flex Strong
343status collapsed
344
345\begin_layout Plain Layout
3461
347\end_layout
348
349\end_inset
350
351and
352\begin_inset Flex Strong
353status collapsed
354
355\begin_layout Plain Layout
356nj_glo
357\end_layout
358
359\end_inset
360
361 of the associated axis.
362 If not specified the default value is
363\begin_inset Flex Strong
364status collapsed
365
366\begin_layout Plain Layout
367nj_glo
368\end_layout
369
370\end_inset
371
372 of the associated axis.
373\end_layout
374
375\begin_layout Subsection
376reduce_domain
377\end_layout
378
379\begin_layout Standard
380Reduce a domain into an axis following a dimension of the domain
381\end_layout
382
383\begin_layout Subsection*
384operation:
385\emph on
386enumeration { min, max, sum, average }
387\end_layout
388
389\begin_layout Standard
390Fortran:
391\end_layout
392
393\begin_layout LyX-Code
394CHARACTER(LEN=*) :: operation
395\end_layout
396
397\begin_layout Standard
398Define the reduction operation can be done.
399 This attribute is mandatory
400\end_layout
401
402\begin_layout Subsection*
403direction:
404\emph on
405enumeration { iDir, jDir }
406\end_layout
407
408\begin_layout Standard
409Fortran:
410\end_layout
411
412\begin_layout LyX-Code
413CHARACTER(LEN=*) :: direction
414\end_layout
415
416\begin_layout Standard
417Define the dimension of domain along which the reduction operation is done:
418 
419\end_layout
420
421\begin_layout Itemize
422
423\series bold
424\emph on
425jDir
426\series default
427\emph default
428: reduction along y dimension of domain
429\end_layout
430
431\begin_layout Itemize
432
433\series bold
434\emph on
435iDir
436\series default
437\emph default
438: reduction along x dimension of domain.
439\end_layout
440
441\begin_layout Standard
442This attribute is mandatory.
443\end_layout
444
445\begin_layout Subsection
446extract_domain
447\end_layout
448
449\begin_layout Standard
450Extract a slice of domain into an axis following a dimension of the domain
451\end_layout
452
453\begin_layout Subsection*
454direction:
455\emph on
456enumeration { iDir, jDir }
457\end_layout
458
459\begin_layout Standard
460Fortran:
461\end_layout
462
463\begin_layout LyX-Code
464CHARACTER(LEN=*) :: direction
465\end_layout
466
467\begin_layout Standard
468Define the dimension of domain along which the extraction operation is done:
469 
470\end_layout
471
472\begin_layout Itemize
473
474\series bold
475\emph on
476jDir
477\series default
478\emph default
479: extract along y dimension of domain
480\end_layout
481
482\begin_layout Itemize
483
484\series bold
485\emph on
486iDir
487\series default
488\emph default
489: extract along x dimension of domain.
490\end_layout
491
492\begin_layout Standard
493This attribute is mandatory.
494\end_layout
495
496\begin_layout Subsection*
497position:
498\begin_inset Flex Emph
499status collapsed
500
501\begin_layout Plain Layout
502integer
503\end_layout
504
505\end_inset
506
507
508\end_layout
509
510\begin_layout Standard
511Fortran:
512\end_layout
513
514\begin_layout LyX-Code
515INTEGER :: position
516\end_layout
517
518\begin_layout Standard
519Position on the dimension of domain with which the extraction is done.
520 This attribute is mandatory.
521\end_layout
522
523\begin_layout Section
524Domain transformation attribute reference
525\end_layout
526
527\begin_layout Subsection
528interpolate_domain
529\end_layout
530
531\begin_layout Standard
532Interpolate a domain to another one.
533\end_layout
534
535\begin_layout Subsection*
536order:
537\emph on
538integer
539\end_layout
540
541\begin_layout Standard
542Fortran:
543\end_layout
544
545\begin_layout LyX-Code
546INTEGER :: order
547\end_layout
548
549\begin_layout Standard
550Define the order of interpolation.
551 This attribute is optional.
552 The default value is 2.
553\end_layout
554
555\begin_layout Subsection*
556renormalize:
557\emph on
558bool
559\end_layout
560
561\begin_layout Standard
562Fortran:
563\end_layout
564
565\begin_layout LyX-Code
566LOGICAL :: renormalize
567\end_layout
568
569\begin_layout Standard
570Define if interpolation normalization is applied.
571 This attribute is optional.
572 The default value is false.
573\end_layout
574
575\begin_layout Subsection*
576write_weight:
577\emph on
578bool
579\end_layout
580
581\begin_layout Standard
582Fortran:
583\end_layout
584
585\begin_layout LyX-Code
586LOGICAL :: write_weight
587\end_layout
588
589\begin_layout Standard
590Define if the weights of interpolation calculation are written into a file.
591 This attribute is optional.
592 The default value is false.
593\end_layout
594
595\begin_layout Subsection*
596weight_filename:
597\emph on
598string
599\end_layout
600
601\begin_layout Standard
602Fortran:
603\end_layout
604
605\begin_layout LyX-Code
606CHARACTER(LEN=*) :: weight_filename
607\end_layout
608
609\begin_layout Standard
610Define the filename into which the calculated weights of interpolation are
611 written or from which these weights are read.
612 This attribute is optional.
613\end_layout
614
615\begin_layout Subsection*
616mode:
617\emph on
618enumeration { compute, read, read_or_compute }
619\end_layout
620
621\begin_layout Standard
622Fortran:
623\end_layout
624
625\begin_layout LyX-Code
626CHARACTER(LEN=*) :: mode
627\end_layout
628
629\begin_layout Standard
630Define the operation mode of interpolation:
631\end_layout
632
633\begin_layout Itemize
634
635\series bold
636\emph on
637compute
638\series default
639\emph default
640: compute the weights of interpolation
641\end_layout
642
643\begin_layout Itemize
644
645\series bold
646\emph on
647read
648\series default
649\emph default
650: read the weights of interpolation from a file whose name is defined by
651 weight_filename
652\end_layout
653
654\begin_layout Itemize
655
656\series bold
657\emph on
658read_or_compute
659\series default
660\emph default
661: if the file whose name is defined by weight_filename already exists, read
662 the weights of interpolation from this file; otherwise weights of interpolation
663 are computed.
664\end_layout
665
666\begin_layout Standard
667In mode compute and read_or_compute, weight_filename is not defined, filename
668 whose format
669\end_layout
670
671\begin_layout Standard
672xios_interpolation_weight_nameOfContext_nameOfDomainSource_nameOfDomainDestinati
673on.nc will be used for read/write.
674\end_layout
675
676\begin_layout Subsection
677zoom_domain
678\end_layout
679
680\begin_layout Subsection*
681ibegin:
682\begin_inset Flex Emph
683status collapsed
684
685\begin_layout Plain Layout
686integer
687\end_layout
688
689\end_inset
690
691
692\end_layout
693
694\begin_layout Standard
695Fortran:
696\end_layout
697
698\begin_layout LyX-Code
699INTEGER :: ibegin
700\end_layout
701
702\begin_layout Standard
703Define the beginning index of the zoomed region on the first dimension of
704 the global domain.
705 This attribute is optional.
706 This must be an integer between
707\begin_inset Flex Strong
708status collapsed
709
710\begin_layout Plain Layout
7110
712\end_layout
713
714\end_inset
715
716 and
717\begin_inset Flex Strong
718status collapsed
719
720\begin_layout Plain Layout
721ni_glo-1
722\end_layout
723
724\end_inset
725
726 of the associated dimension of domain.
727 If not specified the default value is
728\begin_inset Flex Strong
729status collapsed
730
731\begin_layout Plain Layout
7320
733\end_layout
734
735\end_inset
736
737.
738\end_layout
739
740\begin_layout Subsection*
741ni:
742\begin_inset Flex Emph
743status collapsed
744
745\begin_layout Plain Layout
746integer
747\end_layout
748
749\end_inset
750
751
752\end_layout
753
754\begin_layout Standard
755Fortran:
756\end_layout
757
758\begin_layout LyX-Code
759INTEGER :: ni
760\end_layout
761
762\begin_layout Standard
763Define the size of zoomed region on the first dimension of the global domain.
764 This attribute is optional.
765 This must be an integer between
766\begin_inset Flex Strong
767status collapsed
768
769\begin_layout Plain Layout
7701
771\end_layout
772
773\end_inset
774
775and
776\begin_inset Flex Strong
777status collapsed
778
779\begin_layout Plain Layout
780ni_glo
781\end_layout
782
783\end_inset
784
785 of the associated dimension of domain.
786 If not specified the default value is
787\begin_inset Flex Strong
788status collapsed
789
790\begin_layout Plain Layout
791ni_glo
792\end_layout
793
794\end_inset
795
796 of the dimension of domain.
797\end_layout
798
799\begin_layout Subsection*
800jbegin:
801\begin_inset Flex Emph
802status collapsed
803
804\begin_layout Plain Layout
805integer
806\end_layout
807
808\end_inset
809
810
811\end_layout
812
813\begin_layout Standard
814Fortran:
815\end_layout
816
817\begin_layout LyX-Code
818INTEGER :: jbegin
819\end_layout
820
821\begin_layout Standard
822Define the beginning index of the zoomed region on the second dimension
823 of the global domain.
824 This attribute is optional.
825 This must be an integer between
826\begin_inset Flex Strong
827status collapsed
828
829\begin_layout Plain Layout
8300
831\end_layout
832
833\end_inset
834
835 and
836\begin_inset Flex Strong
837status collapsed
838
839\begin_layout Plain Layout
840nj_glo-1
841\end_layout
842
843\end_inset
844
845 of the associated dimension of domain.
846 If not specified the default value is
847\begin_inset Flex Strong
848status collapsed
849
850\begin_layout Plain Layout
8510
852\end_layout
853
854\end_inset
855
856.
857\end_layout
858
859\begin_layout Subsection*
860nj:
861\begin_inset Flex Emph
862status collapsed
863
864\begin_layout Plain Layout
865integer
866\end_layout
867
868\end_inset
869
870
871\end_layout
872
873\begin_layout Standard
874Fortran:
875\end_layout
876
877\begin_layout LyX-Code
878INTEGER :: nj
879\end_layout
880
881\begin_layout Standard
882Define the size of zoomed region on the second dimension of the global domain.
883 This attribute is optional.
884 This must be an integer between
885\begin_inset Flex Strong
886status collapsed
887
888\begin_layout Plain Layout
8891
890\end_layout
891
892\end_inset
893
894and
895\begin_inset Flex Strong
896status collapsed
897
898\begin_layout Plain Layout
899nj_glo
900\end_layout
901
902\end_inset
903
904 of the associated dimension of domain.
905 If not specified the default value is
906\begin_inset Flex Strong
907status collapsed
908
909\begin_layout Plain Layout
910nj_glo
911\end_layout
912
913\end_inset
914
915 of the dimension of domain.
916\end_layout
917
918\begin_layout Subsection
919generate_rectilinear_domain
920\end_layout
921
922\begin_layout Standard
923Generate a rectilinear domain on distributing it among processes as well
924 as on automatically generating its attributes.
925 By default, the bounds_* attributes are used to compute latitude and longitude
926 of the generated domain.
927\end_layout
928
929\begin_layout Subsection*
930lon_start: double
931\end_layout
932
933\begin_layout Standard
934Fortran:
935\end_layout
936
937\begin_layout LyX-Code
938DOUBLE PRECISION :: lon_start
939\end_layout
940
941\begin_layout Standard
942Define the beginning of the longitude of the global domain.
943 This attribute is optional.
944 
945\end_layout
946
947\begin_layout Subsection*
948lon_end: double
949\end_layout
950
951\begin_layout Standard
952Fortran:
953\end_layout
954
955\begin_layout LyX-Code
956DOUBLE PRECISION :: lon_end
957\end_layout
958
959\begin_layout Standard
960Define the ending of the longitude of the global domain.
961 This attribute is optional.
962 
963\end_layout
964
965\begin_layout Subsection*
966lat_start: double
967\end_layout
968
969\begin_layout Standard
970Fortran:
971\end_layout
972
973\begin_layout LyX-Code
974DOUBLE PRECISION :: lat_start
975\end_layout
976
977\begin_layout Standard
978Define the beginning of the latitude of the global domain.
979 This attribute is optional.
980 
981\end_layout
982
983\begin_layout Subsection*
984lat_end: double
985\end_layout
986
987\begin_layout Standard
988Fortran:
989\end_layout
990
991\begin_layout LyX-Code
992DOUBLE PRECISION :: lat_end
993\end_layout
994
995\begin_layout Standard
996Define the ending of the latitude of the global domain.
997 This attribute is optional.
998 
999\end_layout
1000
1001\begin_layout Subsection*
1002bounds_lon_start: double
1003\end_layout
1004
1005\begin_layout Standard
1006Fortran:
1007\end_layout
1008
1009\begin_layout LyX-Code
1010DOUBLE PRECISION :: bounds_lon_start
1011\end_layout
1012
1013\begin_layout Standard
1014Define the beginning of the longitude of the boundary of the global domain.
1015 This attribute is optional.
1016 By default, it is 0.
1017\end_layout
1018
1019\begin_layout Subsection*
1020bounds_lon_end: double
1021\end_layout
1022
1023\begin_layout Standard
1024Fortran:
1025\end_layout
1026
1027\begin_layout LyX-Code
1028DOUBLE PRECISION :: bounds_lon_end
1029\end_layout
1030
1031\begin_layout Standard
1032Define the ending of the longitude of the boundary of the global domain.
1033 This attribute is optional.
1034 By default, it is 360.
1035\end_layout
1036
1037\begin_layout Subsection*
1038bounds_lat_start: double
1039\end_layout
1040
1041\begin_layout Standard
1042Fortran:
1043\end_layout
1044
1045\begin_layout LyX-Code
1046DOUBLE PRECISION :: bounds_lat_start
1047\end_layout
1048
1049\begin_layout Standard
1050Define the beginning of the latitude of the boundary of the global domain.
1051 This attribute is optional.
1052 By default, it is -90.
1053\end_layout
1054
1055\begin_layout Subsection*
1056bounds_lat_end: double
1057\end_layout
1058
1059\begin_layout Standard
1060Fortran:
1061\end_layout
1062
1063\begin_layout LyX-Code
1064DOUBLE PRECISION :: bounds_lat_end
1065\end_layout
1066
1067\begin_layout Standard
1068Define the ending of the latitude of the boundary of the global domain.
1069 This attribute is optional.
1070 By default, it is +90.
1071\end_layout
1072
1073\begin_layout Subsection
1074compute_connectivity_domain
1075\end_layout
1076
1077\begin_layout Standard
1078Compute the neighbors of cells on the local domain.
1079\end_layout
1080
1081\begin_layout Subsection*
1082type:
1083\emph on
1084enumeration { node, edge }
1085\end_layout
1086
1087\begin_layout Standard
1088Fortran:
1089\end_layout
1090
1091\begin_layout LyX-Code
1092CHARACTER(LEN=*) :: type
1093\end_layout
1094
1095\begin_layout Standard
1096Define the type of neighbor:
1097\end_layout
1098
1099\begin_layout Itemize
1100
1101\series bold
1102\emph on
1103node
1104\series default
1105\emph default
1106: cells sharing a node are considered neighbors
1107\end_layout
1108
1109\begin_layout Itemize
1110
1111\series bold
1112\emph on
1113edge
1114\series default
1115\emph default
1116: cells sharing an edge are considered neighbors.
1117\end_layout
1118
1119\begin_layout Standard
1120This attribute is optional.
1121 Default value is edge.
1122\end_layout
1123
1124\begin_layout Subsection*
1125n_neighbor_max:
1126\begin_inset Flex Emph
1127status collapsed
1128
1129\begin_layout Plain Layout
1130integer
1131\end_layout
1132
1133\end_inset
1134
1135
1136\end_layout
1137
1138\begin_layout Standard
1139Fortran:
1140\end_layout
1141
1142\begin_layout LyX-Code
1143INTEGER :: n_neighbor_max
1144\end_layout
1145
1146\begin_layout Standard
1147Attribute contains maximum number of neighbor a cell on the local domain
1148 can have.
1149 This attribute contains returned value.
1150\end_layout
1151
1152\begin_layout Subsection*
1153n_neighbor:
1154\emph on
11551D-array of
1156\emph default
1157 
1158\begin_inset Flex Emph
1159status collapsed
1160
1161\begin_layout Plain Layout
1162integer
1163\end_layout
1164
1165\end_inset
1166
1167
1168\end_layout
1169
1170\begin_layout Standard
1171Fortran:
1172\end_layout
1173
1174\begin_layout LyX-Code
1175INTEGER :: n_neighbor(:)
1176\end_layout
1177
1178\begin_layout Standard
1179Array contains the calculate number of neighbor for cells on the domain.
1180 This attribute contains returned values.
1181\end_layout
1182
1183\begin_layout Subsection*
1184local_neighbor:
1185\emph on
11862D-array of
1187\emph default
1188 
1189\begin_inset Flex Emph
1190status collapsed
1191
1192\begin_layout Plain Layout
1193integer
1194\end_layout
1195
1196\end_inset
1197
1198
1199\end_layout
1200
1201\begin_layout Standard
1202Fortran:
1203\end_layout
1204
1205\begin_layout LyX-Code
1206INTEGER :: n_neighbor(:)
1207\end_layout
1208
1209\begin_layout Standard
1210Array contains the neighbor for cells on the domain.
1211 This attribute contains returned values.
1212\end_layout
1213
1214\begin_layout Subsection
1215expand_domain
1216\end_layout
1217
1218\begin_layout Standard
1219Expand a local domain on adding cells from its neighboring domains.
1220\end_layout
1221
1222\begin_layout Standard
1223For rectilinear domain, global domain is also expanded.
1224 By default, the expanded part is masked.
1225\end_layout
1226
1227\begin_layout Subsection*
1228type:
1229\emph on
1230enumeration { node, edge }
1231\end_layout
1232
1233\begin_layout Standard
1234Fortran:
1235\end_layout
1236
1237\begin_layout LyX-Code
1238CHARACTER(LEN=*) :: type
1239\end_layout
1240
1241\begin_layout Standard
1242Define the type of neighbor:
1243\end_layout
1244
1245\begin_layout Itemize
1246
1247\series bold
1248\emph on
1249node
1250\series default
1251\emph default
1252: cells sharing a node are considered neighbors
1253\end_layout
1254
1255\begin_layout Itemize
1256
1257\series bold
1258\emph on
1259edge
1260\series default
1261\emph default
1262: cells sharing an edge are considered neighbors.
1263\end_layout
1264
1265\begin_layout Standard
1266This attribute is optional.
1267 Default value is edge.
1268\end_layout
1269
1270\begin_layout Subsection*
1271i_periodic:
1272\emph on
1273bool
1274\end_layout
1275
1276\begin_layout Standard
1277Fortran:
1278\end_layout
1279
1280\begin_layout LyX-Code
1281LOGICAL :: i_periodic
1282\end_layout
1283
1284\begin_layout Standard
1285For rectilinear domain, specify if the domain is periodic along x dimension.
1286 This attribute is optional.
1287 The default value is false.
1288\end_layout
1289
1290\begin_layout Subsection*
1291j_periodic:
1292\emph on
1293bool
1294\end_layout
1295
1296\begin_layout Standard
1297Fortran:
1298\end_layout
1299
1300\begin_layout LyX-Code
1301LOGICAL :: j_periodic
1302\end_layout
1303
1304\begin_layout Standard
1305For rectilinear domain, specify if the domain is periodic along y dimension.
1306 This attribute is optional.
1307 The default value is false.
1308\end_layout
1309
1310\end_body
1311\end_document
Note: See TracBrowser for help on using the repository browser.