Changeset 1084 for XIOS/trunk/doc/inputs/user/Axis.lyx

Timestamp:

04/10/17 18:46:02 (7 years ago)

Author:

mhnguyen

Message:

Update user guide and reference guide

File:

• XIOS/trunk/doc/inputs/user/Axis.lyx (modified) (8 diffs)

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

@@ -1 @@
-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 474
+#LyX 2.2 created this file. For more info see http://www.lyx.org/
+\lyxformat 508
 \begin_document
 \begin_header
+\save_transient_properties true
+\origin unavailable
 \textclass book
 \use_default_options true
@@ -11 +13 @@
 \inputencoding auto
 \fontencoding global
-\font_roman default
-\font_sans default
-\font_typewriter default
-\font_math auto
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
 \font_default_family default
 \use_non_tex_fonts false
 \font_sc false
 \font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
 \graphics default
 \default_output_format default
@@ -209 +211 @@
  The axis with implicit id can only be used inside the scope where it is
  defined, it can not be referenced, nor be processed.
- It is rare to define an axis without id inside axis_definition.
+ It is useless to define an axis without id inside axis_definition.
  
 \end_layout
@@ -267 +269 @@
 
 \begin_layout Standard
-Like domain, there are several transformation which can be defined with
- configuration file.
+Like domain, transformation which can be defined inside an axis.
  All transformations on an axis have form *_axis.
- 
-\end_layout
-
-\begin_layout Standard
-Till now, XIOS supports the following transformation on axis:
-\end_layout
-
-\begin_layout Itemize
-zoom_axis: Like zoom functionality in XIOS 1.0, the destination grid is the
- zoomed region of the source grid.
-\end_layout
-
-\begin_layout Itemize
-interpolation_axis: Implement interpolation from an axis to one another.
- For now, only polynominal interpolation is available.
-\end_layout
-
-\begin_layout Itemize
-inverse_axis: Inverse an axis
-\end_layout
-
-\begin_layout Standard
-It is not difficult to define a transformation: Include type of transformation
- inside axis definition, as the following
-\end_layout
-
-\begin_layout Standard
-\begin_inset listings
-lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}"
-inline false
-status open
-
-\begin_layout Plain Layout
-
-<axis_definition>
-\end_layout
-
-\begin_layout Plain Layout
-
-  <axis id="axis_A" />
-\end_layout
-
-\begin_layout Plain Layout
-
-  <axis id="axis_A_zoom" axis_ref="axis_A"> 
-\end_layout
-
-\begin_layout Plain Layout
-
-   <zoom_axis zoom_begin="1" zoom_n="3"/>
-\end_layout
-
-\begin_layout Plain Layout
-
-  </axis>
-\end_layout
-
-\begin_layout Plain Layout
-
-</axis_definition>
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The concrete example is translated as: the axis named axis_A_zoom is transformed
- from axis name axis_A with a zoom activity.
- The detailed attributes of zoom_axis can be found in reference document,
- but simply it contains the begining and size of zoomed region.
-\end_layout
-
-\begin_layout Standard
-One remark is the transformed axis SHOULD have an id, in this case, it's
- axis_A_zoom.
- As mentioned before, a no-id axis or any no-id component of XIOS can only
- be used inside its definition scope.
-\end_layout
-
-\begin_layout Standard
-To make use of transformation, the grid must contain axis which references
- to transformed ones.
- 
-\end_layout
-
-\begin_layout Standard
-\begin_inset listings
-lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}"
-inline false
-status open
-
-\begin_layout Plain Layout
-
-<grid id="grid_A">          
-\end_layout
-
-\begin_layout Plain Layout
-
-  <axis axis_ref="axis_A" />
-\end_layout
-
-\begin_layout Plain Layout
-
-</grid>
-\end_layout
-
-\begin_layout Plain Layout
-
-<grid id="grid_A_zoom">          
-\end_layout
-
-\begin_layout Plain Layout
-
-  <axis axis_ref="axis_A_zoom" />
-\end_layout
-
-\begin_layout Plain Layout
-
-</grid>
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-On defining this way, we tell XIOS to establish a connection between two
- grids by a transformation (zoom) with: grid source - grid_A, grid destination
- - grid_A_zoom.
-\end_layout
-
-\begin_layout Standard
-As mentioned in Grid Chapter, in order to use transformed grid, just reference
- to it in field_definition
-\end_layout
-
-\begin_layout Standard
-\begin_inset listings
-lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}"
-inline false
-status open
-
-\begin_layout Plain Layout
-
-<field_definition level="1" enabled=".TRUE." default_value="9.96921e+36">
-\end_layout
-
-\begin_layout Plain Layout
-
-  <field id="field_A"  operation="average" freq_op="3600s" grid_ref="grid_A"
- />
-\end_layout
-
-\begin_layout Plain Layout
-
-  <field id="field_A_zoom"  operation="average" freq_op="3600s" grid_ref="grid_A
-_zoom" />
-\end_layout
-
-\begin_layout Plain Layout
-
- </field_definition>
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Although xml is helpful to define several configurations, it can not be
- used to customize attributes of axis.
- So it's the turn of Fortran interface.
+ See Chapter 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Transformation"
+
+\end_inset
+
+ for more details.
 \end_layout
 
@@ -453 +286 @@
 
 \begin_layout Standard
-Although axis is not as complexe as domain, there are some mandatory attributes
+Although axis is not as complex as domain, there are some mandatory attributes
  to define.
  Different from precedent version, XIOS 2.0 supports distribution of data
@@ -570 +403 @@
 
 \begin_layout Standard
-Specify the begining and size of data on the local axis:
+Specify the beginning and size of data on the local axis:
 \end_layout
 
@@ -590 +423 @@
 
 \begin_layout Standard
-Although the valid data must be inside a local axis, it is not neccessary
+Although the valid data must be inside a local axis, it is not necessary
  for data to have same size.
  In fact, data can have larger size than local axis.
@@ -623 +456 @@
 
 \begin_layout Standard
-Loal data can be defined with:
+Local data can be defined with:
 \end_layout