Changeset 821 for XIOS/trunk/doc

Timestamp:

02/10/16 14:35:03 (8 years ago)

Author:

mhnguyen

Message:

Making some improvements of transformation algorithm

+) Correct the way to enlisting transformations in an element (domain, axis)
+) Optimize generic transformation to make sure temporary grid to be created on demand
+) Update some mpi tag to prevent conflict
+) Correct some minor stuffs
+) Update documents

Test
+) On Curie
+) all test pass

Location:

XIOS/trunk/doc

Files:

• XIOS_reference_guide.lyx (modified) (20 diffs)
• XIOS_reference_guide.pdf (modified) (previous)
• XIOS_user_guide.pdf (modified) (previous)
• inputs/user/Domain.lyx (modified) (5 diffs)

XIOS/trunk/doc/XIOS_reference_guide.lyx

@@ -1418 +1418 @@
 \end_layout
 
+\begin_layout Subsection*
+index: 
+\begin_inset Flex Emph
+status collapsed
+
+\begin_layout Plain Layout
+1D-array of double
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+DOUBLE PRECISION :: index(:)
+\end_layout
+
+\begin_layout Standard
+Define the global index of axis which the local axis holds.
+ This attribute is optional and the size of the array is equal to 
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+n
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Section
 Domain attribute reference
@@ -1543 +1580 @@
 \begin_layout Standard
 Define the type of the grid.
+ This attribute is mandatory.
 \end_layout
 
@@ -1877 +1915 @@
 
 .
- This attribute is mandatory.
+ This attribute is optional.
 \end_layout
 
@@ -1947 +1985 @@
 
 .
- This attribute is mandatory.
+ This attribute is optional.
 \end_layout
 
@@ -2423 +2461 @@
 
 \begin_layout Standard
-Define the size of the field data for the first dimension.
- This attribute is take account only if 
+Define the size of the field data for the second dimension.
+ This attribute is taken account only if 
 \begin_inset Flex Strong
 status collapsed
@@ -2561 +2599 @@
  in the output file.
  This value is useful in case a field is stored linearly in memory.
- 
+ This attribute is optional.
 \end_layout
 
@@ -2610 +2648 @@
 \begin_layout Standard
 Define the reference of the domain.
- All attributes are inherited from the referenced domain with the classical
+ All attributes are inherited from the referenced domain with the classic
  inheritance mechanism.
  The value assigned to the referenced domain is transmitted to to current
@@ -2617 +2655 @@
 \end_layout
 
+\begin_layout Subsection*
+i_index: 
+\begin_inset Flex Emph
+status collapsed
+
+\begin_layout Plain Layout
+1D-array of double
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+DOUBLE PRECISION :: i_index(:)
+\end_layout
+
+\begin_layout Standard
+Define the global index of the first dimension of domain which the local
+ domain holds.
+ This attribute is optional and by default, the size of the array is equal
+ to 
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+ni*nj
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection*
+j_index: 
+\begin_inset Flex Emph
+status collapsed
+
+\begin_layout Plain Layout
+1D-array of double
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+DOUBLE PRECISION :: j_index(:)
+\end_layout
+
+\begin_layout Standard
+Define the global index of the second dimension of domain which the local
+ domain holds.
+ This attribute is optional and by default, the size of the array is equal
+ to 
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+ni*nj
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Section
 Grid attribute reference
@@ -2657 +2773 @@
 
 \begin_layout Subsection*
-mask: 
+mask_1d: 
 \emph on
 1D-array of bool
@@ -2667 +2783 @@
 
 \begin_layout LyX-Code
-LOGICAL :: mask(:)
+LOGICAL :: mask_1d(:)
 \end_layout
 
@@ -2688 +2804 @@
 
 \begin_layout Subsection*
-mask: 
+mask_2d: 
 \emph on
 2D-array of bool
@@ -2698 +2814 @@
 
 \begin_layout LyX-Code
-LOGICAL :: mask(:,:)
+LOGICAL :: mask_2d(:,:)
 \end_layout
 
@@ -2719 +2835 @@
 
 \begin_layout Subsection*
-mask: 
+mask_3d: 
 \emph on
 3D-array of bool
@@ -2729 +2845 @@
 
 \begin_layout LyX-Code
-LOGICAL :: mask(:,:,:)
+LOGICAL :: mask_3d(:,:,:)
 \end_layout
 
@@ -3237 +3353 @@
 
 \begin_layout Subsection*
+grid_path: 
+\emph on
+string
+\end_layout
+
+\begin_layout Standard
+Fortran: 
+\end_layout
+
+\begin_layout LyX-Code
+CHARACTER(LEN=*) :: grid_path
+\end_layout
+
+\begin_layout Standard
+Define the way operations passing from a grid to others.
+ This attribute is optional.
+\end_layout
+
+\begin_layout Subsection*
 default_value: 
 \emph on
@@ -3624 +3759 @@
 
 \begin_layout Subsection*
+description: 
+\emph on
+string
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+CHARACTER(LEN=*) :: description
+\end_layout
+
+\begin_layout Standard
+Define the description of the file.
+ This attribute is optional.
+\end_layout
+
+\begin_layout Subsection*
 name_suffix: 
 \emph on
@@ -4031 +4185 @@
 \emph default
 .
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Newline newline
-\end_inset
-
-Note that the 
+ Note that the 
 \series bold
 \emph on
@@ -4237 +4384 @@
 
 \begin_layout Subsection*
+time_counter_name: 
+\emph on
+string
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+CHARACTER(LEN=*) :: time_counter_name
+\end_layout
+
+\begin_layout Standard
+Define the name of the time counter.
+ This attribute is optional.
+\end_layout
+
+\begin_layout Subsection*
 timeseries: 
 \emph on
@@ -4247 +4413 @@
 
 \begin_layout LyX-Code
-CHARACTER(LEN=*) :: time_counter
+CHARACTER(LEN=*) :: time_series
 \end_layout
 
@@ -4326 +4492 @@
 \series default
  will be used.
+\end_layout
+
+\begin_layout Subsection*
+record_offset: 
+\emph on
+integer
+\end_layout
+
+\begin_layout Standard
+Fortran:
+\end_layout
+
+\begin_layout LyX-Code
+INTEGER :: record_offset
+\end_layout
+
+\begin_layout Standard
+Define offset of record from the beginning record.
+ This attribute is optional, by default, its value is 0.
 \end_layout
 

XIOS/trunk/doc/inputs/user/Domain.lyx

@@ -317 +317 @@
 interpolation_domain: Implement interpolation from a domain to one another,
  for now XIOS can only do interpolation by reading calculated weight values
- from a file.
- The calculation on the fly will be implemented soon.
+ from a file or calculate the weights on the fly.
 \end_layout
 
@@ -496 +495 @@
  per client process.
  In the next sections, local describes everything related to a client process,
- whereas global means whole data.
+ whereas global means global data.
  The followings describe the essential parts of domain.
  Details of its attributes and operations can be found in XIOS reference
@@ -533 +532 @@
 curvilinear: a 2-dimensional coordinates allows the generality of two axes
  not perpendicular to each other.
- Latitude and longitude have the size equivalent to size of whole domain.
+ Latitude and longitude have the size equivalent to size of local domain.
  
 \end_layout
@@ -692 +691 @@
 \begin_layout Plain Layout
 
-CALL xios_set_domain_attr("domain_A",i_index=iIndex, j_index=jIndex)
+CALL xios_set_domain_attr("domain_A",ni_glo=9, nj_glo=9, i_index=iIndex,
+ j_index=jIndex)
 \end_layout
 
@@ -1030 +1030 @@
 
 \begin_layout Standard
-For curlinear mesh, bounds_lon_2d and bounds_lat_2d provide a convenient
+For curvilinear mesh, bounds_lon_2d and bounds_lat_2d provide a convenient
  way to define longitude and latitude value for the vertex of the cell.
  However, it is possible to use bounds_lon_1d and bounds_lat_1d to describe