Changeset 1084


Ignore:
Timestamp:
04/10/17 18:46:02 (4 years ago)
Author:
mhnguyen
Message:

Update user guide and reference guide

Location:
XIOS/trunk/doc
Files:
4 added
7 edited

Legend:

Unmodified
Added
Removed
  • XIOS/trunk/doc/XIOS_reference_guide.lyx

    r821 r1084  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\use_default_options true 
     
    1315\inputencoding auto 
    1416\fontencoding global 
    15 \font_roman default 
    16 \font_sans default 
    17 \font_typewriter default 
    18 \font_math auto 
     17\font_roman "default" "default" 
     18\font_sans "default" "default" 
     19\font_typewriter "default" "default" 
     20\font_math "auto" "auto" 
    1921\font_default_family default 
    2022\use_non_tex_fonts false 
    2123\font_sc false 
    2224\font_osf false 
    23 \font_sf_scale 100 
    24 \font_tt_scale 100 
     25\font_sf_scale 100 100 
     26\font_tt_scale 100 100 
    2527\graphics default 
    2628\default_output_format default 
     
    8183\end_layout 
    8284 
     85\begin_layout Standard 
     86\begin_inset CommandInset toc 
     87LatexCommand tableofcontents 
     88 
     89\end_inset 
     90 
     91 
     92\end_layout 
     93 
    8394\begin_layout Chapter 
    8495Attribute reference 
     
    273284\begin_layout Standard 
    274285Define the time origin of the time axis. 
    275  It will appear as metadata attached to the time axis in the output file. 
     286 It will appear as meta-data attached to the time axis in the output file. 
    276287 This attribute is optional, the default value is  
    277288\begin_inset Flex Emph 
     
    886897 
    887898\begin_layout Section 
     899Scalar attribute reference 
     900\end_layout 
     901 
     902\begin_layout Subsection* 
     903name:  
     904\begin_inset Flex Emph 
     905status collapsed 
     906 
     907\begin_layout Plain Layout 
     908string 
     909\end_layout 
     910 
     911\end_inset 
     912 
     913 
     914\end_layout 
     915 
     916\begin_layout Standard 
     917Fortran:  
     918\end_layout 
     919 
     920\begin_layout LyX-Code 
     921CHARACTER(LEN=*) :: name 
     922\end_layout 
     923 
     924\begin_layout Standard 
     925Define the name of the scalar, as it will appear in a file. 
     926 If not defined, a name is self generated from the id. 
     927 If multiple scalars are defined in a same file, each name must be different. 
     928  
     929\end_layout 
     930 
     931\begin_layout Subsection* 
     932standard_name:  
     933\begin_inset Flex Emph 
     934status collapsed 
     935 
     936\begin_layout Plain Layout 
     937string 
     938\end_layout 
     939 
     940\end_inset 
     941 
     942 
     943\end_layout 
     944 
     945\begin_layout Standard 
     946Fortran:  
     947\end_layout 
     948 
     949\begin_layout LyX-Code 
     950CHARACTER(LEN=*) :: standard_name 
     951\end_layout 
     952 
     953\begin_layout Standard 
     954Define the standard name of the scalar, as it will appear in the meta-data 
     955 attached to the scalar of the output file. 
     956  
     957\end_layout 
     958 
     959\begin_layout Subsection* 
     960long_name:  
     961\begin_inset Flex Emph 
     962status collapsed 
     963 
     964\begin_layout Plain Layout 
     965string 
     966\end_layout 
     967 
     968\end_inset 
     969 
     970 
     971\end_layout 
     972 
     973\begin_layout Standard 
     974Fortran:  
     975\end_layout 
     976 
     977\begin_layout LyX-Code 
     978CHARACTER(LEN=*) :: long_name 
     979\end_layout 
     980 
     981\begin_layout Standard 
     982Define the long name of the scalar, as it will appear in the meta-data attached 
     983 to the scalar of the output file. 
     984  
     985\end_layout 
     986 
     987\begin_layout Subsection* 
     988unit:  
     989\begin_inset Flex Emph 
     990status collapsed 
     991 
     992\begin_layout Plain Layout 
     993string 
     994\end_layout 
     995 
     996\end_inset 
     997 
     998 
     999\end_layout 
     1000 
     1001\begin_layout Standard 
     1002Fortran:  
     1003\end_layout 
     1004 
     1005\begin_layout LyX-Code 
     1006CHARACTER(LEN=*) :: unit 
     1007\end_layout 
     1008 
     1009\begin_layout Standard 
     1010Define the unit of the scalar as it will appear in the meta-data attached 
     1011 to the scalar in the output file. 
     1012\end_layout 
     1013 
     1014\begin_layout Subsection* 
     1015value:  
     1016\begin_inset Flex Emph 
     1017status collapsed 
     1018 
     1019\begin_layout Plain Layout 
     1020double 
     1021\end_layout 
     1022 
     1023\end_inset 
     1024 
     1025 
     1026\end_layout 
     1027 
     1028\begin_layout Standard 
     1029Fortran: 
     1030\end_layout 
     1031 
     1032\begin_layout LyX-Code 
     1033DOUBLE PRECISION :: value 
     1034\end_layout 
     1035 
     1036\begin_layout Standard 
     1037Define the value of a scalar. 
     1038  
     1039\end_layout 
     1040 
     1041\begin_layout Subsection* 
     1042scalar_ref: string 
     1043\end_layout 
     1044 
     1045\begin_layout Standard 
     1046Fortran: 
     1047\end_layout 
     1048 
     1049\begin_layout LyX-Code 
     1050CHARACTER(LEN=*) :: axis_ref 
     1051\end_layout 
     1052 
     1053\begin_layout Standard 
     1054Define the reference of the scalar. 
     1055 All attributes are inherited from the referenced scalar with the classical 
     1056 inheritance mechanism. 
     1057 The value assigned to the referenced axis is transmitted to to current 
     1058 scalar. 
     1059 This attribute is optional. 
     1060\end_layout 
     1061 
     1062\begin_layout Subsection* 
     1063prec:  
     1064\emph on 
     1065integer 
     1066\end_layout 
     1067 
     1068\begin_layout Standard 
     1069Fortran: 
     1070\end_layout 
     1071 
     1072\begin_layout LyX-Code 
     1073INTEGER :: prec 
     1074\end_layout 
     1075 
     1076\begin_layout Standard 
     1077Define the precision in byte of a field in an output file. 
     1078 Available value are: 2 (integer), 4 (float single precision) and 8 (float 
     1079 double precision). 
     1080\end_layout 
     1081 
     1082\begin_layout Section 
    8881083Axis attribute reference 
    8891084\end_layout 
     
    9431138\begin_layout Standard 
    9441139Define the standard name of the vertical axis, as it will appear in the 
    945  metadata attached to the axis of the output file. 
     1140 meta-data attached to the axis of the output file. 
    9461141  
    9471142\end_layout 
     
    9701165 
    9711166\begin_layout Standard 
    972 Define the long name of the vertical axis, as it will appear in the metadata 
     1167Define the long name of the vertical axis, as it will appear in the meta-data 
    9731168 attached to the axis of the output file. 
    9741169  
     
    9981193 
    9991194\begin_layout Standard 
    1000 Define the unit of the axis as it will appear in the metadata attached to 
    1001  the axis in the output file. 
     1195Define the unit of the axis as it will appear in the meta-data attached 
     1196 to the axis in the output file. 
    10021197\end_layout 
    10031198 
     
    15231718 
    15241719\begin_layout Standard 
    1525 Define the standard name of the domain, as it will appear in the metadata 
     1720Define the standard name of the domain, as it will appear in the meta-data 
    15261721 attached to the domain of the output file. 
    15271722  
     
    15511746 
    15521747\begin_layout Standard 
    1553 Define the long name of the domain, as it will appear in the metadata attached 
     1748Define the long name of the domain, as it will appear in the meta-data attached 
    15541749 to the domain of the output file. 
    15551750  
     
    16601855 
    16611856\begin_layout Standard 
    1662 Define the begining index of the first dimension of the local domain. 
     1857Define the beginning index of the first dimension of the local domain. 
    16631858 This attribute is optional. 
    16641859 This must be an integer between  
     
    18892084\begin_layout Standard 
    18902085Define the value of the longitude on the local domain. 
    1891  For a cartesian grid, the size of the array will be  
     2086 For a Cartesian grid, the size of the array will be  
    18922087\begin_inset Flex Strong 
    18932088status collapsed 
     
    19342129\begin_layout Standard 
    19352130Define the value of the longitude on the local domain. 
    1936  For a cartesian and curvilinear grid, the size of the array will be  
     2131 For a Cartesian and curvilinear grid, the size of the array will be  
    19372132\begin_inset Flex Strong 
    19382133status collapsed 
     
    19692164\begin_layout Standard 
    19702165Define the value of the latitude on the local domain. 
    1971  For a cartesian grid, the size of the array will be nj. 
     2166 For a Cartesian grid, the size of the array will be nj. 
    19722167 For a curvilinear grid, the size of the array will be  
    19732168\begin_inset Flex Strong 
     
    20042199\begin_layout Standard 
    20052200Define the value of the latitude on the local domain. 
    2006  For a cartesian and a curvilinear grid, the size of the array will be  
     2201 For a Cartesian and a curvilinear grid, the size of the array will be  
    20072202\begin_inset Flex Strong 
    20082203status collapsed 
     
    29353130\end_inset 
    29363131 
    2937  attribute as it will appear in the metadata of an output file. 
     3132 attribute as it will appear in the meta-data of an output file. 
    29383133 This attribute is optional. 
    29393134\end_layout 
     
    29643159\end_inset 
    29653160 
    2966  attribute as it will appear in the metadata of an output file. 
     3161 attribute as it will appear in the meta-data of an output file. 
    29673162 This attribute is optional. 
    29683163\end_layout 
     
    34603655 
    34613656\begin_layout LyX-Code 
    3462 LOGICAL: detect_missing_value 
     3657LOGICAL:: detect_missing_value 
    34633658\end_layout 
    34643659 
     
    34793674 
    34803675\begin_layout LyX-Code 
    3481 DOUBLE PRECISION: add_offset 
     3676DOUBLE PRECISION :: add_offset 
    34823677\end_layout 
    34833678 
     
    34933688\end_inset 
    34943689 
    3495  metadata CF attribute in the output file. 
     3690 meta-data CF attribute in the output file. 
    34963691 In output, the  
    34973692\begin_inset Flex Strong 
     
    35183713 
    35193714\begin_layout LyX-Code 
    3520 DOUBLE PRECISION: scale_factor 
     3715DOUBLE PRECISION :: scale_factor 
    35213716\end_layout 
    35223717 
     
    35323727\end_inset 
    35333728 
    3534  metadata CF attribute in the output file. 
     3729 meta-data CF attribute in the output file. 
    35353730 In output, the field values are divided by the  
    35363731\begin_inset Flex Strong 
     
    42054400\series default 
    42064401\emph default 
    4207  only if the NetCDF4 library was compiled with Parallel NetCDF support (--enable 
    4208 -pnetcdf). 
     4402 only if the NetCDF4 library was compiled with Parallel NetCDF support (–enable- 
     4403pnetcdf). 
    42094404\end_layout 
    42104405 
     
    45134708\end_layout 
    45144709 
    4515 \begin_layout Section 
    4516 Transformation attribute reference 
    4517 \end_layout 
    4518  
    4519 \begin_layout Subsection 
    4520 interpolate_axis 
    4521 \end_layout 
    4522  
    4523 \begin_layout Subsection* 
    4524 type:  
    4525 \emph on 
    4526 string 
    4527 \end_layout 
    4528  
    4529 \begin_layout Standard 
    4530 Fortran: 
    4531 \end_layout 
    4532  
    4533 \begin_layout LyX-Code 
    4534 CHARACTER(LEN=*) :: type 
    4535 \end_layout 
    4536  
    4537 \begin_layout Standard 
    4538 Define the type of interpolation on an axis. 
    4539  This attribute is optional. 
    4540 \end_layout 
    4541  
    4542 \begin_layout Subsection* 
    4543 order:  
    4544 \emph on 
    4545 integer 
    4546 \end_layout 
    4547  
    4548 \begin_layout Standard 
    4549 Fortran:  
    4550 \end_layout 
    4551  
    4552 \begin_layout LyX-Code 
    4553 INTEGER :: order 
    4554 \end_layout 
    4555  
    4556 \begin_layout Standard 
    4557 Define a order of interpolation. 
    4558  This attribute is optional. 
    4559  The default value is 2. 
    4560 \end_layout 
    4561  
    4562 \begin_layout Subsection 
    4563 inverse_axis 
    4564 \end_layout 
    4565  
    4566 \begin_layout Subsection 
    4567 zoom_axis 
    4568 \end_layout 
    4569  
    4570 \begin_layout Subsection* 
    4571 begin:  
    4572 \begin_inset Flex Emph 
    4573 status collapsed 
    4574  
    4575 \begin_layout Plain Layout 
    4576 integer 
    4577 \end_layout 
    4578  
    4579 \end_inset 
    4580  
    4581  
    4582 \end_layout 
    4583  
    4584 \begin_layout Standard 
    4585 Fortran: 
    4586 \end_layout 
    4587  
    4588 \begin_layout LyX-Code 
    4589 INTEGER :: begin 
    4590 \end_layout 
    4591  
    4592 \begin_layout Standard 
    4593 Define the begining index of the zoomed region on global axis. 
    4594  This attribute is optional. 
    4595  This must be an integer between  
    4596 \begin_inset Flex Strong 
    4597 status collapsed 
    4598  
    4599 \begin_layout Plain Layout 
    4600 0 
    4601 \end_layout 
    4602  
    4603 \end_inset 
    4604  
    4605  and  
    4606 \begin_inset Flex Strong 
    4607 status collapsed 
    4608  
    4609 \begin_layout Plain Layout 
    4610 ni_glo-1 
    4611 \end_layout 
    4612  
    4613 \end_inset 
    4614  
    4615  of associated axis. 
    4616  If not specified the default value is  
    4617 \begin_inset Flex Strong 
    4618 status collapsed 
    4619  
    4620 \begin_layout Plain Layout 
    4621 0 
    4622 \end_layout 
    4623  
    4624 \end_inset 
    4625  
    4626 . 
    4627 \end_layout 
    4628  
    4629 \begin_layout Subsection* 
    4630 n:  
    4631 \begin_inset Flex Emph 
    4632 status collapsed 
    4633  
    4634 \begin_layout Plain Layout 
    4635 integer 
    4636 \end_layout 
    4637  
    4638 \end_inset 
    4639  
    4640  
    4641 \end_layout 
    4642  
    4643 \begin_layout Standard 
    4644 Fortran: 
    4645 \end_layout 
    4646  
    4647 \begin_layout LyX-Code 
    4648 INTEGER :: n 
    4649 \end_layout 
    4650  
    4651 \begin_layout Standard 
    4652 Define the size of zoomed region on global axis. 
    4653  This attribute is optional. 
    4654  This must be an integer between  
    4655 \begin_inset Flex Strong 
    4656 status collapsed 
    4657  
    4658 \begin_layout Plain Layout 
    4659 1 
    4660 \end_layout 
    4661  
    4662 \end_inset 
    4663  
    4664 and  
    4665 \begin_inset Flex Strong 
    4666 status collapsed 
    4667  
    4668 \begin_layout Plain Layout 
    4669 nj_glo 
    4670 \end_layout 
    4671  
    4672 \end_inset 
    4673  
    4674  of the associated axis. 
    4675  If not specified the default value is  
    4676 \begin_inset Flex Strong 
    4677 status collapsed 
    4678  
    4679 \begin_layout Plain Layout 
    4680 nj_glo 
    4681 \end_layout 
    4682  
    4683 \end_inset 
    4684  
    4685  of the associated axis. 
    4686 \end_layout 
    4687  
    4688 \begin_layout Subsection 
    4689 interpolate_domain 
    4690 \end_layout 
    4691  
    4692 \begin_layout Subsection* 
    4693 file:  
    4694 \emph on 
    4695 string 
    4696 \end_layout 
    4697  
    4698 \begin_layout Standard 
    4699 Fortran: 
    4700 \end_layout 
    4701  
    4702 \begin_layout LyX-Code 
    4703 CHARACTER(LEN=*) :: type 
    4704 \end_layout 
    4705  
    4706 \begin_layout Standard 
    4707 Define the file which contains the weight value to interpolate from domain 
    4708  source to domain destination. 
    4709  This attribute is optional. 
    4710  If not specified, the internal interpolation module will be used. 
    4711 \end_layout 
    4712  
    4713 \begin_layout Subsection* 
    4714 order:  
    4715 \emph on 
    4716 integer 
    4717 \end_layout 
    4718  
    4719 \begin_layout Standard 
    4720 Fortran:  
    4721 \end_layout 
    4722  
    4723 \begin_layout LyX-Code 
    4724 INTEGER :: order 
    4725 \end_layout 
    4726  
    4727 \begin_layout Standard 
    4728 Define a order of interpolation. 
    4729  This attribute is only for internal interoplation module. 
    4730  This attribute is optional. 
    4731  The default value is 2. 
    4732 \end_layout 
    4733  
    4734 \begin_layout Subsection 
    4735 zoom_domain 
    4736 \end_layout 
    4737  
    4738 \begin_layout Subsection* 
    4739 ibegin:  
    4740 \begin_inset Flex Emph 
    4741 status collapsed 
    4742  
    4743 \begin_layout Plain Layout 
    4744 integer 
    4745 \end_layout 
    4746  
    4747 \end_inset 
    4748  
    4749  
    4750 \end_layout 
    4751  
    4752 \begin_layout Standard 
    4753 Fortran: 
    4754 \end_layout 
    4755  
    4756 \begin_layout LyX-Code 
    4757 INTEGER :: ibegin 
    4758 \end_layout 
    4759  
    4760 \begin_layout Standard 
    4761 Define the begining index of the zoomed region on the first dimension of 
    4762  the global domain. 
    4763  This attribute is optional. 
    4764  This must be an integer between  
    4765 \begin_inset Flex Strong 
    4766 status collapsed 
    4767  
    4768 \begin_layout Plain Layout 
    4769 0 
    4770 \end_layout 
    4771  
    4772 \end_inset 
    4773  
    4774  and  
    4775 \begin_inset Flex Strong 
    4776 status collapsed 
    4777  
    4778 \begin_layout Plain Layout 
    4779 ni_glo-1 
    4780 \end_layout 
    4781  
    4782 \end_inset 
    4783  
    4784  of the associated dimension of domain. 
    4785  If not specified the default value is  
    4786 \begin_inset Flex Strong 
    4787 status collapsed 
    4788  
    4789 \begin_layout Plain Layout 
    4790 0 
    4791 \end_layout 
    4792  
    4793 \end_inset 
    4794  
    4795 . 
    4796 \end_layout 
    4797  
    4798 \begin_layout Subsection* 
    4799 ni:  
    4800 \begin_inset Flex Emph 
    4801 status collapsed 
    4802  
    4803 \begin_layout Plain Layout 
    4804 integer 
    4805 \end_layout 
    4806  
    4807 \end_inset 
    4808  
    4809  
    4810 \end_layout 
    4811  
    4812 \begin_layout Standard 
    4813 Fortran: 
    4814 \end_layout 
    4815  
    4816 \begin_layout LyX-Code 
    4817 INTEGER :: ni 
    4818 \end_layout 
    4819  
    4820 \begin_layout Standard 
    4821 Define the size of zoomed region on the first dimension of the global domain. 
    4822  This attribute is optional. 
    4823  This must be an integer between  
    4824 \begin_inset Flex Strong 
    4825 status collapsed 
    4826  
    4827 \begin_layout Plain Layout 
    4828 1 
    4829 \end_layout 
    4830  
    4831 \end_inset 
    4832  
    4833 and  
    4834 \begin_inset Flex Strong 
    4835 status collapsed 
    4836  
    4837 \begin_layout Plain Layout 
    4838 ni_glo 
    4839 \end_layout 
    4840  
    4841 \end_inset 
    4842  
    4843  of the associated dimension of domain. 
    4844  If not specified the default value is  
    4845 \begin_inset Flex Strong 
    4846 status collapsed 
    4847  
    4848 \begin_layout Plain Layout 
    4849 ni_glo 
    4850 \end_layout 
    4851  
    4852 \end_inset 
    4853  
    4854  of the dimension of domain. 
    4855 \end_layout 
    4856  
    4857 \begin_layout Subsection* 
    4858 jbegin:  
    4859 \begin_inset Flex Emph 
    4860 status collapsed 
    4861  
    4862 \begin_layout Plain Layout 
    4863 integer 
    4864 \end_layout 
    4865  
    4866 \end_inset 
    4867  
    4868  
    4869 \end_layout 
    4870  
    4871 \begin_layout Standard 
    4872 Fortran: 
    4873 \end_layout 
    4874  
    4875 \begin_layout LyX-Code 
    4876 INTEGER :: jbegin 
    4877 \end_layout 
    4878  
    4879 \begin_layout Standard 
    4880 Define the begining index of the zoomed region on the second dimension of 
    4881  the global domain. 
    4882  This attribute is optional. 
    4883  This must be an integer between  
    4884 \begin_inset Flex Strong 
    4885 status collapsed 
    4886  
    4887 \begin_layout Plain Layout 
    4888 0 
    4889 \end_layout 
    4890  
    4891 \end_inset 
    4892  
    4893  and  
    4894 \begin_inset Flex Strong 
    4895 status collapsed 
    4896  
    4897 \begin_layout Plain Layout 
    4898 nj_glo-1 
    4899 \end_layout 
    4900  
    4901 \end_inset 
    4902  
    4903  of the associated dimension of domain. 
    4904  If not specified the default value is  
    4905 \begin_inset Flex Strong 
    4906 status collapsed 
    4907  
    4908 \begin_layout Plain Layout 
    4909 0 
    4910 \end_layout 
    4911  
    4912 \end_inset 
    4913  
    4914 . 
    4915 \end_layout 
    4916  
    4917 \begin_layout Subsection* 
    4918 nj:  
    4919 \begin_inset Flex Emph 
    4920 status collapsed 
    4921  
    4922 \begin_layout Plain Layout 
    4923 integer 
    4924 \end_layout 
    4925  
    4926 \end_inset 
    4927  
    4928  
    4929 \end_layout 
    4930  
    4931 \begin_layout Standard 
    4932 Fortran: 
    4933 \end_layout 
    4934  
    4935 \begin_layout LyX-Code 
    4936 INTEGER :: nj 
    4937 \end_layout 
    4938  
    4939 \begin_layout Standard 
    4940 Define the size of zoomed region on the second dimension of the global domain. 
    4941  This attribute is optional. 
    4942  This must be an integer between  
    4943 \begin_inset Flex Strong 
    4944 status collapsed 
    4945  
    4946 \begin_layout Plain Layout 
    4947 1 
    4948 \end_layout 
    4949  
    4950 \end_inset 
    4951  
    4952 and  
    4953 \begin_inset Flex Strong 
    4954 status collapsed 
    4955  
    4956 \begin_layout Plain Layout 
    4957 nj_glo 
    4958 \end_layout 
    4959  
    4960 \end_inset 
    4961  
    4962  of the associated dimension of domain. 
    4963  If not specified the default value is  
    4964 \begin_inset Flex Strong 
    4965 status collapsed 
    4966  
    4967 \begin_layout Plain Layout 
    4968 nj_glo 
    4969 \end_layout 
    4970  
    4971 \end_inset 
    4972  
    4973  of the dimension of domain. 
    4974 \end_layout 
    4975  
    4976 \begin_layout Subsection 
    4977 generate_rectilinear_domain 
    4978 \end_layout 
    4979  
    4980 \begin_layout Standard 
     4710\begin_layout Standard 
     4711\begin_inset CommandInset include 
     4712LatexCommand include 
     4713filename "inputs/reference/Transformations.lyx" 
     4714 
     4715\end_inset 
     4716 
    49814717 
    49824718\end_layout 
     
    51274863\begin_layout Itemize 
    51284864If OASIS coupler is not used (using_oasis=false) 
     4865\begin_inset Separator latexpar 
     4866\end_inset 
     4867 
     4868 
    51294869\end_layout 
    51304870 
     
    52655005 
    52665006) 
     5007\begin_inset Separator latexpar 
     5008\end_inset 
     5009 
     5010 
    52675011\end_layout 
    52685012 
     
    52805024 
    52815025)  
     5026\begin_inset Separator latexpar 
     5027\end_inset 
     5028 
     5029 
    52825030\end_layout 
    52835031 
     
    53905138 
    53915139) 
     5140\begin_inset Separator latexpar 
     5141\end_inset 
     5142 
     5143 
    53925144\end_layout 
    53935145 
     
    75217273 
    75227274\begin_layout Subsection* 
    7523 Arithmetic operations on durations 
    7524 \end_layout 
    7525  
    7526 \begin_layout Standard 
    7527 The following arithmetic operations on durations are available: 
     7275Arithmetic operations on duration 
     7276\end_layout 
     7277 
     7278\begin_layout Standard 
     7279The following arithmetic operations on duration are available: 
    75287280\end_layout 
    75297281 
     
    75957347 
    75967348\begin_layout Subsection* 
    7597 Comparison operations on durations 
    7598 \end_layout 
    7599  
    7600 \begin_layout Standard 
    7601 The following comparison operations on durations are available: 
     7349Comparison operations on duration 
     7350\end_layout 
     7351 
     7352\begin_layout Standard 
     7353The following comparison operations on duration are available: 
    76027354\end_layout 
    76037355 
  • XIOS/trunk/doc/XIOS_user_guide.lyx

    r916 r1084  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\begin_preamble 
     
    1618\inputencoding auto 
    1719\fontencoding global 
    18 \font_roman default 
    19 \font_sans default 
    20 \font_typewriter default 
    21 \font_math auto 
     20\font_roman "default" "default" 
     21\font_sans "default" "default" 
     22\font_typewriter "default" "default" 
     23\font_math "auto" "auto" 
    2224\font_default_family default 
    2325\use_non_tex_fonts false 
    2426\font_sc false 
    2527\font_osf false 
    26 \font_sf_scale 100 
    27 \font_tt_scale 100 
     28\font_sf_scale 100 100 
     29\font_tt_scale 100 100 
    2830\graphics default 
    2931\default_output_format default 
     
    8082\end_layout 
    8183 
    82 \begin_layout Author 
    83 Draft 
     84\begin_layout Standard 
     85\begin_inset CommandInset toc 
     86LatexCommand tableofcontents 
     87 
     88\end_inset 
     89 
     90 
    8491\end_layout 
    8592 
     
    11921199\begin_layout Itemize 
    11931200converting dates to 
     1201\begin_inset Separator latexpar 
     1202\end_inset 
     1203 
     1204 
    11941205\end_layout 
    11951206 
     
    17671778 
    17681779\begin_layout Plain Layout 
    1769 -\SpecialChar \nobreakdash- 
     1780-\SpecialChar nobreakdash 
    17701781-enable-netcdf4 
    17711782\end_layout 
     
    18101821 
    18111822\begin_layout Plain Layout 
    1812 -\SpecialChar \nobreakdash- 
     1823-\SpecialChar nobreakdash 
    18131824-enable-parallel 
    18141825\end_layout 
     
    18531864 
    18541865\begin_layout Plain Layout 
    1855 -\SpecialChar \nobreakdash- 
     1866-\SpecialChar nobreakdash 
    18561867-enable-pnetcdf 
    18571868\end_layout 
     
    47994810\end_layout 
    48004811 
     4812\begin_layout Standard 
     4813\begin_inset CommandInset include 
     4814LatexCommand include 
     4815filename "inputs/user/Scalar.lyx" 
     4816 
     4817\end_inset 
     4818 
     4819 
     4820\end_layout 
     4821 
     4822\begin_layout Standard 
     4823\begin_inset CommandInset include 
     4824LatexCommand include 
     4825filename "inputs/user/Transformations.lyx" 
     4826 
     4827\end_inset 
     4828 
     4829 
     4830\end_layout 
     4831 
    48014832\begin_layout Chapter 
    48024833XIOS options 
     
    49684999 mode, XIOS will ensure that all active fields can be buffered without having 
    49695000 to flush the buffers. 
    4970  This mode is used by default since it allows more asynchronism and thus 
     5001 This mode is used by default since it allows more asynchronous and thus 
    49715002 better performance at the cost of being quite memory hungry. 
    49725003\end_layout 
     
    49815012int 
    49825013\series default 
    4983 ) defines the mimimum buffer size in bytes (8192 by default). 
     5014) defines the minimum buffer size in bytes (8192 by default). 
    49845015 This value will be used by XIOS only for buffers whose detected size is 
    4985  smaller than the user defined mimimum size. 
     5016 smaller than the user defined minimum size. 
    49865017\end_layout 
    49875018 
     
    50045035\begin_inset Formula  
    50055036\[ 
    5006 {\scriptstyle used\_size\;=\;\min\left(minimum\_buffer\_size,\; detected\_size\;\times\; buffer\_size\_factor\right)} 
     5037{\scriptstyle used\_size\;=\;\min\left(minimum\_buffer\_size,\;detected\_size\;\times\;buffer\_size\_factor\right)} 
    50075038\] 
    50085039 
  • XIOS/trunk/doc/inputs/user/Axis.lyx

    r797 r1084  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\use_default_options true 
     
    1113\inputencoding auto 
    1214\fontencoding global 
    13 \font_roman default 
    14 \font_sans default 
    15 \font_typewriter default 
    16 \font_math auto 
     15\font_roman "default" "default" 
     16\font_sans "default" "default" 
     17\font_typewriter "default" "default" 
     18\font_math "auto" "auto" 
    1719\font_default_family default 
    1820\use_non_tex_fonts false 
    1921\font_sc false 
    2022\font_osf false 
    21 \font_sf_scale 100 
    22 \font_tt_scale 100 
     23\font_sf_scale 100 100 
     24\font_tt_scale 100 100 
    2325\graphics default 
    2426\default_output_format default 
     
    209211 The axis with implicit id can only be used inside the scope where it is 
    210212 defined, it can not be referenced, nor be processed. 
    211  It is rare to define an axis without id inside axis_definition. 
     213 It is useless to define an axis without id inside axis_definition. 
    212214  
    213215\end_layout 
     
    267269 
    268270\begin_layout Standard 
    269 Like domain, there are several transformation which can be defined with 
    270  configuration file. 
     271Like domain, transformation which can be defined inside an axis. 
    271272 All transformations on an axis have form *_axis. 
    272   
    273 \end_layout 
    274  
    275 \begin_layout Standard 
    276 Till now, XIOS supports the following transformation on axis: 
    277 \end_layout 
    278  
    279 \begin_layout Itemize 
    280 zoom_axis: Like zoom functionality in XIOS 1.0, the destination grid is the 
    281  zoomed region of the source grid. 
    282 \end_layout 
    283  
    284 \begin_layout Itemize 
    285 interpolation_axis: Implement interpolation from an axis to one another. 
    286  For now, only polynominal interpolation is available. 
    287 \end_layout 
    288  
    289 \begin_layout Itemize 
    290 inverse_axis: Inverse an axis 
    291 \end_layout 
    292  
    293 \begin_layout Standard 
    294 It is not difficult to define a transformation: Include type of transformation 
    295  inside axis definition, as the following 
    296 \end_layout 
    297  
    298 \begin_layout Standard 
    299 \begin_inset listings 
    300 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    301 inline false 
    302 status open 
    303  
    304 \begin_layout Plain Layout 
    305  
    306 <axis_definition> 
    307 \end_layout 
    308  
    309 \begin_layout Plain Layout 
    310  
    311   <axis id="axis_A" /> 
    312 \end_layout 
    313  
    314 \begin_layout Plain Layout 
    315  
    316   <axis id="axis_A_zoom" axis_ref="axis_A">  
    317 \end_layout 
    318  
    319 \begin_layout Plain Layout 
    320  
    321    <zoom_axis zoom_begin="1" zoom_n="3"/> 
    322 \end_layout 
    323  
    324 \begin_layout Plain Layout 
    325  
    326   </axis> 
    327 \end_layout 
    328  
    329 \begin_layout Plain Layout 
    330  
    331 </axis_definition> 
    332 \end_layout 
    333  
    334 \end_inset 
    335  
    336  
    337 \end_layout 
    338  
    339 \begin_layout Standard 
    340 The concrete example is translated as: the axis named axis_A_zoom is transformed 
    341  from axis name axis_A with a zoom activity. 
    342  The detailed attributes of zoom_axis can be found in reference document, 
    343  but simply it contains the begining and size of zoomed region. 
    344 \end_layout 
    345  
    346 \begin_layout Standard 
    347 One remark is the transformed axis SHOULD have an id, in this case, it's 
    348  axis_A_zoom. 
    349  As mentioned before, a no-id axis or any no-id component of XIOS can only 
    350  be used inside its definition scope. 
    351 \end_layout 
    352  
    353 \begin_layout Standard 
    354 To make use of transformation, the grid must contain axis which references 
    355  to transformed ones. 
    356   
    357 \end_layout 
    358  
    359 \begin_layout Standard 
    360 \begin_inset listings 
    361 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    362 inline false 
    363 status open 
    364  
    365 \begin_layout Plain Layout 
    366  
    367 <grid id="grid_A">           
    368 \end_layout 
    369  
    370 \begin_layout Plain Layout 
    371  
    372   <axis axis_ref="axis_A" /> 
    373 \end_layout 
    374  
    375 \begin_layout Plain Layout 
    376  
    377 </grid> 
    378 \end_layout 
    379  
    380 \begin_layout Plain Layout 
    381  
    382 <grid id="grid_A_zoom">           
    383 \end_layout 
    384  
    385 \begin_layout Plain Layout 
    386  
    387   <axis axis_ref="axis_A_zoom" /> 
    388 \end_layout 
    389  
    390 \begin_layout Plain Layout 
    391  
    392 </grid> 
    393 \end_layout 
    394  
    395 \end_inset 
    396  
    397  
    398 \end_layout 
    399  
    400 \begin_layout Standard 
    401 On defining this way, we tell XIOS to establish a connection between two 
    402  grids by a transformation (zoom) with: grid source - grid_A, grid destination 
    403  - grid_A_zoom. 
    404 \end_layout 
    405  
    406 \begin_layout Standard 
    407 As mentioned in Grid Chapter, in order to use transformed grid, just reference 
    408  to it in field_definition 
    409 \end_layout 
    410  
    411 \begin_layout Standard 
    412 \begin_inset listings 
    413 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    414 inline false 
    415 status open 
    416  
    417 \begin_layout Plain Layout 
    418  
    419 <field_definition level="1" enabled=".TRUE." default_value="9.96921e+36"> 
    420 \end_layout 
    421  
    422 \begin_layout Plain Layout 
    423  
    424   <field id="field_A"  operation="average" freq_op="3600s" grid_ref="grid_A" 
    425  /> 
    426 \end_layout 
    427  
    428 \begin_layout Plain Layout 
    429  
    430   <field id="field_A_zoom"  operation="average" freq_op="3600s" grid_ref="grid_A 
    431 _zoom" /> 
    432 \end_layout 
    433  
    434 \begin_layout Plain Layout 
    435  
    436  </field_definition> 
    437 \end_layout 
    438  
    439 \end_inset 
    440  
    441  
    442 \end_layout 
    443  
    444 \begin_layout Standard 
    445 Although xml is helpful to define several configurations, it can not be 
    446  used to customize attributes of axis. 
    447  So it's the turn of Fortran interface. 
     273 See Chapter  
     274\begin_inset CommandInset ref 
     275LatexCommand ref 
     276reference "chap:Transformation" 
     277 
     278\end_inset 
     279 
     280 for more details. 
    448281\end_layout 
    449282 
     
    453286 
    454287\begin_layout Standard 
    455 Although axis is not as complexe as domain, there are some mandatory attributes 
     288Although axis is not as complex as domain, there are some mandatory attributes 
    456289 to define. 
    457290 Different from precedent version, XIOS 2.0 supports distribution of data 
     
    570403 
    571404\begin_layout Standard 
    572 Specify the begining and size of data on the local axis: 
     405Specify the beginning and size of data on the local axis: 
    573406\end_layout 
    574407 
     
    590423 
    591424\begin_layout Standard 
    592 Although the valid data must be inside a local axis, it is not neccessary 
     425Although the valid data must be inside a local axis, it is not necessary 
    593426 for data to have same size. 
    594427 In fact, data can have larger size than local axis. 
     
    623456 
    624457\begin_layout Standard 
    625 Loal data can be defined with: 
     458Local data can be defined with: 
    626459\end_layout 
    627460 
  • XIOS/trunk/doc/inputs/user/Domain.lyx

    r821 r1084  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\use_default_options true 
     
    1113\inputencoding auto 
    1214\fontencoding global 
    13 \font_roman default 
    14 \font_sans default 
    15 \font_typewriter default 
    16 \font_math auto 
     15\font_roman "default" "default" 
     16\font_sans "default" "default" 
     17\font_typewriter "default" "default" 
     18\font_math "auto" "auto" 
    1719\font_default_family default 
    1820\use_non_tex_fonts false 
    1921\font_sc false 
    2022\font_osf false 
    21 \font_sf_scale 100 
    22 \font_tt_scale 100 
     23\font_sf_scale 100 100 
     24\font_tt_scale 100 100 
    2325\graphics default 
    2426\default_output_format default 
     
    143145\color inherit 
    144146 among this kind of components. 
    145  It is not allowed to have two domains with a same id, but it is permitted 
    146  a domain and a grid, for example, to share a same one. 
     147 Domains defined by a same Id always represent only one domain. 
    147148\end_layout 
    148149 
     
    181182\begin_layout Standard 
    182183Very often, after a domain is defined, it may be referenced many times. 
    183  To make a reference to a domain, we use domain_ref 
     184 To make a reference to a domain, we use  
     185\shape italic 
     186domain_ref 
    184187\end_layout 
    185188 
     
    216219 The domain with implicit id can only be used inside the scope where it 
    217220 is defined, it can not be referenced, nor be processed. 
    218  It is rare to define a domain without id inside domain_definition. 
    219  However, the domain_ref is utilized widely outside the scope of domain_definiti 
    220 on. 
     221 It is useless to define a domain without id inside domain_definition. 
     222 Meanwhile, the domain_ref is utilized widely outside the scope of domain_defini 
     223tion. 
    221224\end_layout 
    222225 
     
    230233\series default 
    231234\color inherit 
    232 Moreover it is the only region where we can define a new domain outside 
     235However, it is the only region where we can define a new domain outside 
    233236 domain_definition. 
    234237\end_layout 
     
    286289 
    287290\begin_layout Standard 
    288 One of a new concept which differenciates XIOS 2.0 from its precedent is 
    289  transformation. 
    290  In a simple case, zoom feature is now considered to be a transformation. 
    291  It can be more complicated for other geometric transformation such as inversion 
    292  or interpolation. 
    293  All transformation are taken place on grid level. 
    294  It means that it is neccessary to define a grid source and a grid destination 
    295  as well as a transformation or list of transformation which we'd like to 
    296  have. 
    297  In order to transform a grid to one another, we need to specify a transformatio 
    298 n on its sub-component: domain or axis. 
    299 \end_layout 
    300  
    301 \begin_layout Standard 
    302 Because transformation on a domain is different from one on an axis, we 
    303  differenciate two categories of transformation: transformation_domain and 
    304  transformation_axis. 
    305 \end_layout 
    306  
    307 \begin_layout Standard 
    308 Till now, XIOS supports the following transformation on domain: 
    309 \end_layout 
    310  
    311 \begin_layout Itemize 
    312 zoom_domain: Like zoom functionality in XIOS 1.0, the destination grid is 
    313  the zoomed region of the source grid. 
    314 \end_layout 
    315  
    316 \begin_layout Itemize 
    317 interpolation_domain: Implement interpolation from a domain to one another, 
    318  for now XIOS can only do interpolation by reading calculated weight values 
    319  from a file or calculate the weights on the fly. 
    320 \end_layout 
    321  
    322 \begin_layout Itemize 
    323 generate_rectilinear_domain: auto generating, distributing a rectilinear 
    324  domain then filling all mandatory attributes. 
    325 \end_layout 
    326  
    327 \begin_layout Standard 
    328 It is not difficult to define a transformation: Include type of transformation 
    329  inside domain definition, as the following 
    330 \end_layout 
    331  
    332 \begin_layout Standard 
    333 \begin_inset listings 
    334 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    335 inline false 
    336 status open 
    337  
    338 \begin_layout Plain Layout 
    339  
    340 <domain_definition> 
    341 \end_layout 
    342  
    343 \begin_layout Plain Layout 
    344  
    345   <domain id="domain_A" /> 
    346 \end_layout 
    347  
    348 \begin_layout Plain Layout 
    349  
    350   <domain id="domain_A_zoom" domain_ref="domain_A">  
    351 \end_layout 
    352  
    353 \begin_layout Plain Layout 
    354  
    355    <zoom_domain zoom_ibegin="1" zoom_ni="3" zoom_jbegin="0" zoom_nj="2"/> 
    356 \end_layout 
    357  
    358 \begin_layout Plain Layout 
    359  
    360   </domain> 
    361 \end_layout 
    362  
    363 \begin_layout Plain Layout 
    364  
    365 </domain_definition> 
    366 \end_layout 
    367  
    368 \end_inset 
    369  
    370  
    371 \end_layout 
    372  
    373 \begin_layout Standard 
    374 The concrete example above tells many things: a domain named domain_A_zoom 
    375  is transformed from domain name domain_A with a zoom activity. 
    376  The domain_A_zoom is the zoomed region of domain_A. 
    377  The detailed attributes of zoom_domain can be found in reference document, 
    378  but simply it contains the begining and size of zoomed region. 
    379 \end_layout 
    380  
    381 \begin_layout Standard 
    382 One remark is the transformed domain SHOULD have an id, in this case, it's 
    383  domain_A_zoom. 
    384  As mentioned before, a no-id domain or any no-id component of XIOS can 
    385  only be used inside its definition scope. 
    386  It exists but is useless. 
    387  So care about that. 
    388 \end_layout 
    389  
    390 \begin_layout Standard 
    391 To make use of transformation, the grid must contain domains which reference 
    392  to transformed ones. 
    393   
    394 \end_layout 
    395  
    396 \begin_layout Standard 
    397 \begin_inset listings 
    398 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    399 inline false 
    400 status open 
    401  
    402 \begin_layout Plain Layout 
    403  
    404 <grid id="grid_A">           
    405 \end_layout 
    406  
    407 \begin_layout Plain Layout 
    408  
    409    <domain domain_ref="domain_A" /> 
    410 \end_layout 
    411  
    412 \begin_layout Plain Layout 
    413  
    414  </grid> 
    415 \end_layout 
    416  
    417 \begin_layout Plain Layout 
    418  
    419 <grid id="grid_A_zoom">           
    420 \end_layout 
    421  
    422 \begin_layout Plain Layout 
    423  
    424    <domain domain_ref="domain_A_zoom" /> 
    425 \end_layout 
    426  
    427 \begin_layout Plain Layout 
    428  
    429  </grid> 
    430 \end_layout 
    431  
    432 \end_inset 
    433  
    434  
    435 \end_layout 
    436  
    437 \begin_layout Standard 
    438 On defining this way, we tell XIOS to establish a connection between two 
    439  grids by a transformation (zoom) with: grid source - grid_A, grid destination 
    440  - grid_A_zoom. 
    441 \end_layout 
    442  
    443 \begin_layout Standard 
    444 As mentioned in Grid Chapter, in order to use transformed grid, just reference 
    445  to it in field_definition 
    446 \end_layout 
    447  
    448 \begin_layout Standard 
    449 \begin_inset listings 
    450 lstparams "language=XML,breaklines=true,tabsize=2,frame=tb,postbreak={\raisebox{0ex}[0ex][0ex]{\ensuremath{\rcurvearrowse\space}}}" 
    451 inline false 
    452 status open 
    453  
    454 \begin_layout Plain Layout 
    455  
    456 <field_definition level="1" enabled=".TRUE." default_value="9.96921e+36"> 
    457 \end_layout 
    458  
    459 \begin_layout Plain Layout 
    460  
    461   <field id="field_A"  operation="average" freq_op="3600s" grid_ref="grid_A" 
    462  /> 
    463 \end_layout 
    464  
    465 \begin_layout Plain Layout 
    466  
    467   <field id="field_A_zoom"  operation="average" freq_op="3600s" grid_ref="grid_A 
    468 _zoom" /> 
    469 \end_layout 
    470  
    471 \begin_layout Plain Layout 
    472  
    473  </field_definition> 
    474 \end_layout 
    475  
    476 \end_inset 
    477  
    478  
    479 \end_layout 
    480  
    481 \begin_layout Standard 
    482 Although xml is helpful to define several configurations, it is not convenient 
    483  to customize attributes of domain. 
    484  So it's the turn of Fortran interface. 
     291One of a new concept which differentiates XIOS 2.0 from its precedent is 
     292 (spatial) transformation, which can be defined inside a domain. 
     293 All transformations on a domain have form *_domain. 
     294 See Chapter  
     295\begin_inset CommandInset ref 
     296LatexCommand ref 
     297reference "chap:Transformation" 
     298 
     299\end_inset 
     300 
     301 for more details. 
    485302\end_layout 
    486303 
     
    526343rectilinear: a simple 2-dimensional Cartesian coordinates with two perpendicular 
    527344 axes. 
    528  Latitude represents the y-axe while longitude represents the x-axe. 
     345 Latitude represents the y-axis while longitude represents the x-axe. 
    529346\end_layout 
    530347 
     
    537354 
    538355\begin_layout Itemize 
    539 unstructured: not any of two above, the latitutude and longitude, as curvilinear 
    540 , are reprensented with the help of boundaries. 
     356unstructured: not any of two above, the latitude and longitude, as curvilinear, 
     357 are represented with the help of boundaries. 
    541358  
    542359\end_layout 
     
    564381 
    565382\begin_layout Standard 
    566 Althoug there are different domain types, they share the similar patterns 
     383Although there are different domain types, they share the similar patterns 
    567384 to settle local data on a client process: There are some essential attributes 
    568385 to define. 
     
    578395It is not uncommon that a global domain is broken into several pieces, each 
    579396 of which is distributed to one process. 
    580  Following we consider a simple case: a domain of rectilinear type with 
     397 Following, we consider a simple case: a domain of rectilinear type with 
    581398 global size 9 x 9 and its data is distributed evenly among 9 client processes, 
    582399 each of which has 3x3. 
     
    634451 
    635452\begin_layout Itemize 
     453ibegin, jbegin: global position on x-axis and y-axis where a local domain 
     454 begin 
     455\end_layout 
     456 
     457\begin_layout Itemize 
     458ni, nj: local size of domain of each process on x-axis and y-axis 
     459\end_layout 
     460 
     461\begin_layout Itemize 
    636462ni_glo, nj_glo: global size of x-axis and y-axis correspondingly. 
    637463  
    638464\end_layout 
    639465 
    640 \begin_layout Itemize 
    641 ibegin, jbegin: global position on x-axis and y-axis where a local domain 
    642  begin 
    643 \end_layout 
    644  
    645 \begin_layout Itemize 
    646 ni, nj: local size of domain of each process on x-axis and y-axis 
    647 \end_layout 
    648  
    649466\begin_layout Standard 
    650467Or tell XIOS exactly the global position of each point in the local domain, 
     
    717534 
    718535\begin_layout Standard 
    719 Specify the begining and size of data on the local domain: 
     536Specify the beginning and size of data on the local domain: 
    720537\end_layout 
    721538 
    722539\begin_layout Itemize 
    723540data_ibegin, data_jbegin: the local position of data on x-axis and y-axis 
    724  where data begins 
     541 where data begins inside the local domain 
    725542\end_layout 
    726543 
     
    772589 
    773590\begin_layout Standard 
    774 In order to be processed correctly, data must be specified with the begining 
     591In order to be processed correctly, data must be specified with the beginning 
    775592 and size of its block . 
    776593 For two-dimensional data, it can be done with data_ibegin, data_ni for 
     
    778595 In case of one-dimensional data, it is only necessary to determine data_ibegin 
    779596 and data_ni. 
    780  Although the valid data must be inside a local domain, it is not neccessary 
     597 Although the valid data must be inside a local domain, it is not necessary 
    781598 for data to have same size as local domain. 
    782599 In fact, data can have larger size than domain on each dimension, this 
     
    857674 
    858675\begin_layout Standard 
    859 With the secon way, data can be represented with: 
     676With the second way, data can be represented with: 
    860677\end_layout 
    861678 
     
    891708\begin_layout Standard 
    892709As mentioned, data on a domain are two-dimensional but in some cases, there 
    893  is a need to write data continously, there comes one-dimensional data. 
     710 is a need to write data continuously, there comes one-dimensional data. 
    894711 With the precedent example, we can define one dimensional data with: 
    895712\end_layout 
     
    921738\begin_layout Standard 
    922739Above are the mandatory attributes to define local domain. 
    923  There are some auxilliary attributes which make data meaningful, especially 
     740 There are some auxiliary attributes which make data meaningful, especially 
    924741 for meteorological one. 
    925  The next section disscuses these attributes. 
     742 The next section discuses these attributes. 
    926743\end_layout 
    927744 
     
    931748 
    932749\begin_layout Standard 
    933 Different from the previous version, in XIOS 2.0, lonngitude and latitude 
     750Different from the previous version, in XIOS 2.0, longitude and latitude 
    934751 are optional. 
    935752 Moreover, to be coherent to the data_dim concept, there are more ways to 
     
    1025842\begin_layout Standard 
    1026843For unstructured mesh, a cell can have different number of vertices than 
    1027  rectinlinear, in this case, longitude and latitude value of the vertex 
    1028  of cell are specified with bounds_lon_1d and bounds_lat_1d. 
     844 rectilinear, in this case, longitude and latitude value of the vertex of 
     845 cell are specified with bounds_lon_1d and bounds_lat_1d. 
    1029846\end_layout 
    1030847 
     
    1038855\begin_layout Standard 
    1039856One thing to remind, only *_1d or *_2d attributes are used, if *_1d and 
    1040  *_2d of a same attribute are provides, there will be runtime error. 
     857 *_2d of a same attribute are provides, there will be run-time error. 
    1041858\end_layout 
    1042859 
  • XIOS/trunk/doc/inputs/user/Grid.lyx

    r669 r1084  
    1 #LyX 2.1 created this file. For more info see http://www.lyx.org/ 
    2 \lyxformat 474 
     1#LyX 2.2 created this file. For more info see http://www.lyx.org/ 
     2\lyxformat 508 
    33\begin_document 
    44\begin_header 
     5\save_transient_properties true 
     6\origin unavailable 
    57\textclass book 
    68\use_default_options true 
     
    1113\inputencoding auto 
    1214\fontencoding global 
    13 \font_roman default 
    14 \font_sans default 
    15 \font_typewriter default 
    16 \font_math auto 
     15\font_roman "default" "default" 
     16\font_sans "default" "default" 
     17\font_typewriter "default" "default" 
     18\font_math "auto" "auto" 
    1719\font_default_family default 
    1820\use_non_tex_fonts false 
    1921\font_sc false 
    2022\font_osf false 
    21 \font_sf_scale 100 
    22 \font_tt_scale 100 
     23\font_sf_scale 100 100 
     24\font_tt_scale 100 100 
    2325\graphics default 
    2426\default_output_format default 
     
    236238\color inherit 
    237239 among this kind of components. 
    238  It is not allowed to have two grids with a same id, but it is permitted 
    239  a grid and, for example, a domain to share a same one. 
    240   
     240 If several grids use same Id, they all represent only one grid. 
    241241\end_layout 
    242242 
     
    415415 is often used as time step axis. 
    416416 In order to write only time step to netCDF, XIOS provides a special way 
    417  to do: empty grid - a grid without any domain or axis. 
     417 to do: scalar grid - a grid composed of a scalar 
    418418\end_layout 
    419419 
     
    426426\begin_layout Plain Layout 
    427427 
    428  <grid id="grid_TimeStep">  
     428<grid id="grid_TimeStep">  
     429\end_layout 
     430 
     431\begin_layout Plain Layout 
     432 
     433  <scalar id="scalar" /> 
    429434\end_layout 
    430435 
Note: See TracChangeset for help on using the changeset viewer.