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

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

Update reference guide

File size: 21.2 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
297n_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
356n_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
367n_glo
368\end_layout
369
370\end_inset
371
372 of the associated axis.
373\end_layout
374
375\begin_layout Subsection*
376index:
377\emph on
3781D-array of
379\emph default
380 
381\begin_inset Flex Emph
382status collapsed
383
384\begin_layout Plain Layout
385integer
386\end_layout
387
388\end_inset
389
390
391\end_layout
392
393\begin_layout Standard
394Fortran:
395\end_layout
396
397\begin_layout LyX-Code
398INTEGER :: index(:)
399\end_layout
400
401\begin_layout Standard
402Array contains the zoomed point on the global axis.
403 This attribute is optional.
404 This must contain only integer values between
405\begin_inset Flex Strong
406status collapsed
407
408\begin_layout Plain Layout
4090
410\end_layout
411
412\end_inset
413
414and
415\begin_inset Flex Strong
416status collapsed
417
418\begin_layout Plain Layout
419n_glo-1
420\end_layout
421
422\end_inset
423
424 of the associated axis.
425 If not specified, begin and n are used for zoom of the associated axis.
426\end_layout
427
428\begin_layout Subsection
429reduce_domain
430\end_layout
431
432\begin_layout Standard
433Reduce a domain into an axis following a dimension of the domain
434\end_layout
435
436\begin_layout Subsection*
437operation:
438\emph on
439enumeration { min, max, sum, average }
440\end_layout
441
442\begin_layout Standard
443Fortran:
444\end_layout
445
446\begin_layout LyX-Code
447CHARACTER(LEN=*) :: operation
448\end_layout
449
450\begin_layout Standard
451Define the reduction operation can be done.
452 This attribute is mandatory
453\end_layout
454
455\begin_layout Subsection*
456direction:
457\emph on
458enumeration { iDir, jDir }
459\end_layout
460
461\begin_layout Standard
462Fortran:
463\end_layout
464
465\begin_layout LyX-Code
466CHARACTER(LEN=*) :: direction
467\end_layout
468
469\begin_layout Standard
470Define the dimension of domain along which the reduction operation is done:
471 
472\end_layout
473
474\begin_layout Itemize
475
476\series bold
477\emph on
478jDir
479\series default
480\emph default
481: reduction along y dimension of domain
482\end_layout
483
484\begin_layout Itemize
485
486\series bold
487\emph on
488iDir
489\series default
490\emph default
491: reduction along x dimension of domain.
492\end_layout
493
494\begin_layout Standard
495This attribute is mandatory.
496\end_layout
497
498\begin_layout Subsection
499extract_domain
500\end_layout
501
502\begin_layout Standard
503Extract a slice of domain into an axis following a dimension of the domain
504\end_layout
505
506\begin_layout Subsection*
507direction:
508\emph on
509enumeration { iDir, jDir }
510\end_layout
511
512\begin_layout Standard
513Fortran:
514\end_layout
515
516\begin_layout LyX-Code
517CHARACTER(LEN=*) :: direction
518\end_layout
519
520\begin_layout Standard
521Define the dimension of domain along which the extraction operation is done:
522 
523\end_layout
524
525\begin_layout Itemize
526
527\series bold
528\emph on
529jDir
530\series default
531\emph default
532: extract along y dimension of domain
533\end_layout
534
535\begin_layout Itemize
536
537\series bold
538\emph on
539iDir
540\series default
541\emph default
542: extract along x dimension of domain.
543\end_layout
544
545\begin_layout Standard
546This attribute is mandatory.
547\end_layout
548
549\begin_layout Subsection*
550position:
551\begin_inset Flex Emph
552status collapsed
553
554\begin_layout Plain Layout
555integer
556\end_layout
557
558\end_inset
559
560
561\end_layout
562
563\begin_layout Standard
564Fortran:
565\end_layout
566
567\begin_layout LyX-Code
568INTEGER :: position
569\end_layout
570
571\begin_layout Standard
572Position on the dimension of domain with which the extraction is done.
573 This attribute is mandatory.
574\end_layout
575
576\begin_layout Section
577Domain transformation attribute reference
578\end_layout
579
580\begin_layout Subsection
581interpolate_domain
582\end_layout
583
584\begin_layout Standard
585Interpolate a domain to another one.
586\end_layout
587
588\begin_layout Subsection*
589order:
590\emph on
591integer
592\end_layout
593
594\begin_layout Standard
595Fortran:
596\end_layout
597
598\begin_layout LyX-Code
599INTEGER :: order
600\end_layout
601
602\begin_layout Standard
603Define the order of interpolation.
604 This attribute is optional.
605 The default value is 2.
606\end_layout
607
608\begin_layout Subsection*
609renormalize:
610\emph on
611bool
612\end_layout
613
614\begin_layout Standard
615Fortran:
616\end_layout
617
618\begin_layout LyX-Code
619LOGICAL :: renormalize
620\end_layout
621
622\begin_layout Standard
623Define if interpolation normalization is applied.
624 This attribute is optional.
625 The default value is false.
626\end_layout
627
628\begin_layout Subsection*
629write_weight:
630\emph on
631bool
632\end_layout
633
634\begin_layout Standard
635Fortran:
636\end_layout
637
638\begin_layout LyX-Code
639LOGICAL :: write_weight
640\end_layout
641
642\begin_layout Standard
643Define if the weights of interpolation calculation are written into a file.
644 This attribute is optional.
645 The default value is false.
646\end_layout
647
648\begin_layout Subsection*
649weight_filename:
650\emph on
651string
652\end_layout
653
654\begin_layout Standard
655Fortran:
656\end_layout
657
658\begin_layout LyX-Code
659CHARACTER(LEN=*) :: weight_filename
660\end_layout
661
662\begin_layout Standard
663Define the filename into which the calculated weights of interpolation are
664 written or from which these weights are read.
665 This attribute is optional.
666\end_layout
667
668\begin_layout Subsection*
669mode:
670\emph on
671enumeration { compute, read, read_or_compute }
672\end_layout
673
674\begin_layout Standard
675Fortran:
676\end_layout
677
678\begin_layout LyX-Code
679CHARACTER(LEN=*) :: mode
680\end_layout
681
682\begin_layout Standard
683Define the operation mode of interpolation:
684\end_layout
685
686\begin_layout Itemize
687
688\series bold
689\emph on
690compute
691\series default
692\emph default
693: compute the weights of interpolation
694\end_layout
695
696\begin_layout Itemize
697
698\series bold
699\emph on
700read
701\series default
702\emph default
703: read the weights of interpolation from a file whose name is defined by
704 weight_filename
705\end_layout
706
707\begin_layout Itemize
708
709\series bold
710\emph on
711read_or_compute
712\series default
713\emph default
714: if the file whose name is defined by weight_filename already exists, read
715 the weights of interpolation from this file; otherwise weights of interpolation
716 are computed.
717\end_layout
718
719\begin_layout Standard
720In mode compute and read_or_compute, weight_filename is not defined, filename
721 whose format
722\end_layout
723
724\begin_layout Standard
725xios_interpolation_weight_nameOfContext_nameOfDomainSource_nameOfDomainDestinati
726on.nc will be used for read/write.
727\end_layout
728
729\begin_layout Subsection
730zoom_domain
731\end_layout
732
733\begin_layout Subsection*
734ibegin:
735\begin_inset Flex Emph
736status collapsed
737
738\begin_layout Plain Layout
739integer
740\end_layout
741
742\end_inset
743
744
745\end_layout
746
747\begin_layout Standard
748Fortran:
749\end_layout
750
751\begin_layout LyX-Code
752INTEGER :: ibegin
753\end_layout
754
755\begin_layout Standard
756Define the beginning index of the zoomed region on the first dimension of
757 the global domain.
758 This attribute is optional.
759 This must be an integer between
760\begin_inset Flex Strong
761status collapsed
762
763\begin_layout Plain Layout
7640
765\end_layout
766
767\end_inset
768
769 and
770\begin_inset Flex Strong
771status collapsed
772
773\begin_layout Plain Layout
774ni_glo-1
775\end_layout
776
777\end_inset
778
779 of the associated dimension of domain.
780 If not specified the default value is
781\begin_inset Flex Strong
782status collapsed
783
784\begin_layout Plain Layout
7850
786\end_layout
787
788\end_inset
789
790.
791\end_layout
792
793\begin_layout Subsection*
794ni:
795\begin_inset Flex Emph
796status collapsed
797
798\begin_layout Plain Layout
799integer
800\end_layout
801
802\end_inset
803
804
805\end_layout
806
807\begin_layout Standard
808Fortran:
809\end_layout
810
811\begin_layout LyX-Code
812INTEGER :: ni
813\end_layout
814
815\begin_layout Standard
816Define the size of zoomed region on the first dimension of the global domain.
817 This attribute is optional.
818 This must be an integer between
819\begin_inset Flex Strong
820status collapsed
821
822\begin_layout Plain Layout
8231
824\end_layout
825
826\end_inset
827
828and
829\begin_inset Flex Strong
830status collapsed
831
832\begin_layout Plain Layout
833ni_glo
834\end_layout
835
836\end_inset
837
838 of the associated dimension of domain.
839 If not specified the default value is
840\begin_inset Flex Strong
841status collapsed
842
843\begin_layout Plain Layout
844ni_glo
845\end_layout
846
847\end_inset
848
849 of the dimension of domain.
850\end_layout
851
852\begin_layout Subsection*
853jbegin:
854\begin_inset Flex Emph
855status collapsed
856
857\begin_layout Plain Layout
858integer
859\end_layout
860
861\end_inset
862
863
864\end_layout
865
866\begin_layout Standard
867Fortran:
868\end_layout
869
870\begin_layout LyX-Code
871INTEGER :: jbegin
872\end_layout
873
874\begin_layout Standard
875Define the beginning index of the zoomed region on the second dimension
876 of the global domain.
877 This attribute is optional.
878 This must be an integer between
879\begin_inset Flex Strong
880status collapsed
881
882\begin_layout Plain Layout
8830
884\end_layout
885
886\end_inset
887
888 and
889\begin_inset Flex Strong
890status collapsed
891
892\begin_layout Plain Layout
893nj_glo-1
894\end_layout
895
896\end_inset
897
898 of the associated dimension of domain.
899 If not specified the default value is
900\begin_inset Flex Strong
901status collapsed
902
903\begin_layout Plain Layout
9040
905\end_layout
906
907\end_inset
908
909.
910\end_layout
911
912\begin_layout Subsection*
913nj:
914\begin_inset Flex Emph
915status collapsed
916
917\begin_layout Plain Layout
918integer
919\end_layout
920
921\end_inset
922
923
924\end_layout
925
926\begin_layout Standard
927Fortran:
928\end_layout
929
930\begin_layout LyX-Code
931INTEGER :: nj
932\end_layout
933
934\begin_layout Standard
935Define the size of zoomed region on the second dimension of the global domain.
936 This attribute is optional.
937 This must be an integer between
938\begin_inset Flex Strong
939status collapsed
940
941\begin_layout Plain Layout
9421
943\end_layout
944
945\end_inset
946
947and
948\begin_inset Flex Strong
949status collapsed
950
951\begin_layout Plain Layout
952nj_glo
953\end_layout
954
955\end_inset
956
957 of the associated dimension of domain.
958 If not specified the default value is
959\begin_inset Flex Strong
960status collapsed
961
962\begin_layout Plain Layout
963nj_glo
964\end_layout
965
966\end_inset
967
968 of the dimension of domain.
969\end_layout
970
971\begin_layout Subsection
972generate_rectilinear_domain
973\end_layout
974
975\begin_layout Standard
976Generate a rectilinear domain on distributing it among processes as well
977 as on automatically generating its attributes.
978 By default, the bounds_* attributes are used to compute latitude and longitude
979 of the generated domain.
980\end_layout
981
982\begin_layout Subsection*
983lon_start: double
984\end_layout
985
986\begin_layout Standard
987Fortran:
988\end_layout
989
990\begin_layout LyX-Code
991DOUBLE PRECISION :: lon_start
992\end_layout
993
994\begin_layout Standard
995Define the beginning of the longitude of the global domain.
996 This attribute is optional.
997 
998\end_layout
999
1000\begin_layout Subsection*
1001lon_end: double
1002\end_layout
1003
1004\begin_layout Standard
1005Fortran:
1006\end_layout
1007
1008\begin_layout LyX-Code
1009DOUBLE PRECISION :: lon_end
1010\end_layout
1011
1012\begin_layout Standard
1013Define the ending of the longitude of the global domain.
1014 This attribute is optional.
1015 
1016\end_layout
1017
1018\begin_layout Subsection*
1019lat_start: double
1020\end_layout
1021
1022\begin_layout Standard
1023Fortran:
1024\end_layout
1025
1026\begin_layout LyX-Code
1027DOUBLE PRECISION :: lat_start
1028\end_layout
1029
1030\begin_layout Standard
1031Define the beginning of the latitude of the global domain.
1032 This attribute is optional.
1033 
1034\end_layout
1035
1036\begin_layout Subsection*
1037lat_end: double
1038\end_layout
1039
1040\begin_layout Standard
1041Fortran:
1042\end_layout
1043
1044\begin_layout LyX-Code
1045DOUBLE PRECISION :: lat_end
1046\end_layout
1047
1048\begin_layout Standard
1049Define the ending of the latitude of the global domain.
1050 This attribute is optional.
1051 
1052\end_layout
1053
1054\begin_layout Subsection*
1055bounds_lon_start: double
1056\end_layout
1057
1058\begin_layout Standard
1059Fortran:
1060\end_layout
1061
1062\begin_layout LyX-Code
1063DOUBLE PRECISION :: bounds_lon_start
1064\end_layout
1065
1066\begin_layout Standard
1067Define the beginning of the longitude of the boundary of the global domain.
1068 This attribute is optional.
1069 By default, it is 0.
1070\end_layout
1071
1072\begin_layout Subsection*
1073bounds_lon_end: double
1074\end_layout
1075
1076\begin_layout Standard
1077Fortran:
1078\end_layout
1079
1080\begin_layout LyX-Code
1081DOUBLE PRECISION :: bounds_lon_end
1082\end_layout
1083
1084\begin_layout Standard
1085Define the ending of the longitude of the boundary of the global domain.
1086 This attribute is optional.
1087 By default, it is 360.
1088\end_layout
1089
1090\begin_layout Subsection*
1091bounds_lat_start: double
1092\end_layout
1093
1094\begin_layout Standard
1095Fortran:
1096\end_layout
1097
1098\begin_layout LyX-Code
1099DOUBLE PRECISION :: bounds_lat_start
1100\end_layout
1101
1102\begin_layout Standard
1103Define the beginning of the latitude of the boundary of the global domain.
1104 This attribute is optional.
1105 By default, it is -90.
1106\end_layout
1107
1108\begin_layout Subsection*
1109bounds_lat_end: double
1110\end_layout
1111
1112\begin_layout Standard
1113Fortran:
1114\end_layout
1115
1116\begin_layout LyX-Code
1117DOUBLE PRECISION :: bounds_lat_end
1118\end_layout
1119
1120\begin_layout Standard
1121Define the ending of the latitude of the boundary of the global domain.
1122 This attribute is optional.
1123 By default, it is +90.
1124\end_layout
1125
1126\begin_layout Subsection
1127compute_connectivity_domain
1128\end_layout
1129
1130\begin_layout Standard
1131Compute the neighbors of cells on the local domain.
1132\end_layout
1133
1134\begin_layout Subsection*
1135type:
1136\emph on
1137enumeration { node, edge }
1138\end_layout
1139
1140\begin_layout Standard
1141Fortran:
1142\end_layout
1143
1144\begin_layout LyX-Code
1145CHARACTER(LEN=*) :: type
1146\end_layout
1147
1148\begin_layout Standard
1149Define the type of neighbor:
1150\end_layout
1151
1152\begin_layout Itemize
1153
1154\series bold
1155\emph on
1156node
1157\series default
1158\emph default
1159: cells sharing a node are considered neighbors
1160\end_layout
1161
1162\begin_layout Itemize
1163
1164\series bold
1165\emph on
1166edge
1167\series default
1168\emph default
1169: cells sharing an edge are considered neighbors.
1170\end_layout
1171
1172\begin_layout Standard
1173This attribute is optional.
1174 Default value is edge.
1175\end_layout
1176
1177\begin_layout Subsection*
1178n_neighbor_max:
1179\begin_inset Flex Emph
1180status collapsed
1181
1182\begin_layout Plain Layout
1183integer
1184\end_layout
1185
1186\end_inset
1187
1188
1189\end_layout
1190
1191\begin_layout Standard
1192Fortran:
1193\end_layout
1194
1195\begin_layout LyX-Code
1196INTEGER :: n_neighbor_max
1197\end_layout
1198
1199\begin_layout Standard
1200Attribute contains maximum number of neighbor a cell on the local domain
1201 can have.
1202 This attribute contains returned value.
1203\end_layout
1204
1205\begin_layout Subsection*
1206n_neighbor:
1207\emph on
12081D-array of
1209\emph default
1210 
1211\begin_inset Flex Emph
1212status collapsed
1213
1214\begin_layout Plain Layout
1215integer
1216\end_layout
1217
1218\end_inset
1219
1220
1221\end_layout
1222
1223\begin_layout Standard
1224Fortran:
1225\end_layout
1226
1227\begin_layout LyX-Code
1228INTEGER :: n_neighbor(:)
1229\end_layout
1230
1231\begin_layout Standard
1232Array contains the calculate number of neighbor for cells on the domain.
1233 This attribute contains returned values.
1234\end_layout
1235
1236\begin_layout Subsection*
1237local_neighbor:
1238\emph on
12392D-array of
1240\emph default
1241 
1242\begin_inset Flex Emph
1243status collapsed
1244
1245\begin_layout Plain Layout
1246integer
1247\end_layout
1248
1249\end_inset
1250
1251
1252\end_layout
1253
1254\begin_layout Standard
1255Fortran:
1256\end_layout
1257
1258\begin_layout LyX-Code
1259INTEGER :: n_neighbor(:)
1260\end_layout
1261
1262\begin_layout Standard
1263Array contains the neighbor for cells on the domain.
1264 This attribute contains returned values.
1265\end_layout
1266
1267\begin_layout Subsection
1268expand_domain
1269\end_layout
1270
1271\begin_layout Standard
1272Expand a local domain on adding cells from its neighboring domains.
1273\end_layout
1274
1275\begin_layout Standard
1276For rectilinear domain, global domain is also expanded.
1277 By default, the expanded part is masked.
1278\end_layout
1279
1280\begin_layout Subsection*
1281type:
1282\emph on
1283enumeration { node, edge }
1284\end_layout
1285
1286\begin_layout Standard
1287Fortran:
1288\end_layout
1289
1290\begin_layout LyX-Code
1291CHARACTER(LEN=*) :: type
1292\end_layout
1293
1294\begin_layout Standard
1295Define the type of neighbor:
1296\end_layout
1297
1298\begin_layout Itemize
1299
1300\series bold
1301\emph on
1302node
1303\series default
1304\emph default
1305: cells sharing a node are considered neighbors
1306\end_layout
1307
1308\begin_layout Itemize
1309
1310\series bold
1311\emph on
1312edge
1313\series default
1314\emph default
1315: cells sharing an edge are considered neighbors.
1316\end_layout
1317
1318\begin_layout Standard
1319This attribute is optional.
1320 Default value is edge.
1321\end_layout
1322
1323\begin_layout Subsection*
1324i_periodic:
1325\emph on
1326bool
1327\end_layout
1328
1329\begin_layout Standard
1330Fortran:
1331\end_layout
1332
1333\begin_layout LyX-Code
1334LOGICAL :: i_periodic
1335\end_layout
1336
1337\begin_layout Standard
1338For rectilinear domain, specify if the domain is periodic along x dimension.
1339 This attribute is optional.
1340 The default value is false.
1341\end_layout
1342
1343\begin_layout Subsection*
1344j_periodic:
1345\emph on
1346bool
1347\end_layout
1348
1349\begin_layout Standard
1350Fortran:
1351\end_layout
1352
1353\begin_layout LyX-Code
1354LOGICAL :: j_periodic
1355\end_layout
1356
1357\begin_layout Standard
1358For rectilinear domain, specify if the domain is periodic along y dimension.
1359 This attribute is optional.
1360 The default value is false.
1361\end_layout
1362
1363\end_body
1364\end_document
Note: See TracBrowser for help on using the repository browser.