Changes between Initial Version and Version 1 of doc/app/nesting_parameters

Timestamp:

Feb 28, 2016 7:57:16 AM (9 years ago)

Author:

raasch

Comment:

--

doc/app/nesting_parameters

@@ +1 @@
+
+= Nesting parameters =
+
+\\\\
+NAMELIST group name: [=#nestpar '''nestpar''']\\
+----
+
+
+[=#mode '''Mode:]\\
+||='''Parameter Name'''  =||='''[../fortrantypes FORTRAN]\\[../fortrantypes Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#domain_layouts '''domain_layouts''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+derived \\
+TYPE \\
+pmc_layout(64)
+}}}
+{{{#!td style="vertical-align:top;width: 75px"
+none
+}}}
+{{{#!td
+General informations about the nested domains to be used.\\\\
+Up to 64 domains can be used. The derived data type has the structure
+{{{
+   TYPE pmc_layout
+
+      CHARACTER(len=32) ::  name
+
+      INTEGER  ::  id
+      INTEGER  ::  parent_id
+      INTEGER  ::  npe_x
+      INTEGER  ::  npe_y
+
+      REAL(wp) ::  lower_left_x
+      REAL(wp) ::  lower_left_y
+
+   END TYPE pmc_layout
+}}}
+{{{name}}} is the domain name given by the user. {{{id}}} is the number of the domain (can be arbitrarily chosen, but it would be good practise to number the domains in ascending order starting with 1), while {{{parent_id}}} gives the number of the domain in which this domain is embedded. The so-called ''root''-domain which includes all other ''nested''-domains should have the id 1. The ''root''-domain has no ''parent''-domain and must be given ''-1'' as its {{{parent_id}}}. {{{npe_x}}} and {{{npe_y}}} are the number of PEs to be used along x and y for this domain (i.e. the virtual PE-grid of the domain). {{{lower_left_x}}} and {{{lower_left_y}}} are the coordinates in m of the south-left scalar (?) gridpoint of the domain. The ''root''-domain has {{{lower_left_x}}} = ''0.0'' and {{{lower_left_y}}} = ''0.0''. A ''nested''-domain must be completely embedded in its ''parent''-domain. \\\\
+The following gives an example for defining a single nested-domain embedded in a root-domain:
+{{{
+domain_layouts = 'coarse',  1,  -1,  4,   4,    0.0,    0.0,
+                 'fine',    2,   1,  4,   4,  320.0,  128.0, 
+}}}
+The total number of MPI-processes required by this configuration is 4*4 + 4*4 = 32.
+}}}
+|----------------
+{{{#!td style="vertical-align:top"
+[=#nesting_mode '''nesting_mode''']
+}}}
+{{{#!td style="vertical-align:top"
+C*7
+}}}
+{{{#!td style="vertical-align:top"
+'' 'two-way' ''
+}}}
+{{{#!td
+Type of nesting mode.\\\\ 
+''one-way'' or ''two-way'' nesting is allowed.
+}}}