1 | <model name="descprint" title="Comments on how to fill upt the degub window" layout="flat"> |
---|
2 | <desc> |
---|
3 | Enter the total simulation length, the amount of debug information written by OASIS3-MCT |
---|
4 | in the "debug" files, whether or not some time statistic information must be printed |
---|
5 | and whether or not there will be some grouped fields in the namcouple.[] |
---|
6 | The blue (?) gives more information on each data to fill up. |
---|
7 | </desc> |
---|
8 | </model> |
---|
9 | |
---|
10 | <model name="runtime" title="Runtime" layout="flat"> |
---|
11 | <param name="duration" title="Simulation length in sec (integer)" type="integer"/> |
---|
12 | <docu> |
---|
13 | [section=Runtime] |
---|
14 | This number is the total simulated time of the run, expressed in seconds (or any other time units as |
---|
15 | long as the same are used in all models and in the configuration file). |
---|
16 | </docu> |
---|
17 | </model> |
---|
18 | |
---|
19 | <model name="debug" title="Debug printing options" layout="flat"> |
---|
20 | <xor name="nlogprt" title="Select the Debugging level" default="none"> |
---|
21 | <model name="none" title="0"> |
---|
22 | </model> |
---|
23 | <model name="ptr_1" title="1"> |
---|
24 | </model> |
---|
25 | <model name="ptr_2" title="2"> |
---|
26 | </model> |
---|
27 | <model name="ptr_5" title="5"> |
---|
28 | </model> |
---|
29 | <model name="ptr_10" title="10"> |
---|
30 | </model> |
---|
31 | <model name="ptr_12" title="12"> |
---|
32 | </model> |
---|
33 | <model name="ptr_15" title="15"> |
---|
34 | </model> |
---|
35 | <model name="ptr_20" title="20"> |
---|
36 | </model> |
---|
37 | <model name="ptr_30" title="30"> |
---|
38 | </model> |
---|
39 | </xor> |
---|
40 | <docu> |
---|
41 | |
---|
42 | [section=Debug files] |
---|
43 | The debug level number refers to the amount of debug information written by OASIS3-MCT |
---|
44 | in the "debug" files. In production mode, it should be 0. |
---|
45 | |
---|
46 | In debug mode on massively parallel computer, it should be 1. If it is not enough, it should be |
---|
47 | then 30, the maximum value. |
---|
48 | |
---|
49 | Detailed information about the meaning of each Debugging level can be found in the User |
---|
50 | Guide, section 3.2 (see the NLOGPRT keyword). |
---|
51 | |
---|
52 | <docuold> |
---|
53 | |
---|
54 | The number corresponds to :[] |
---|
55 | 0 : one file debug.root.xx is open by the master proces of each model |
---|
56 | and one file debug_notroot.xx is open for all the other processes of |
---|
57 | each model to write only error information. [] |
---|
58 | 1 : one file debug.root.xx is open by the master proces of each model to |
---|
59 | write information equivalent to level 10 (see below); one file debug.notroot.xx |
---|
60 | is open for all the other processes of each model to write error information. [] |
---|
61 | 2 : one file debug.xx.xxxxxx is open by each process of each model to write normal |
---|
62 | production diagnostics. [] |
---|
63 | 5 : as for 2 with in addition some initial debug info. [] |
---|
64 | 10: as for 5 with in addition the routine calling tree. [] |
---|
65 | 12: as for 10 with in addition some routine calling notes. [] |
---|
66 | 15: as for 12 with even more debug diagnostics. [] |
---|
67 | 20: as for 15 with in addition some extra runtime analysis. [] |
---|
68 | 30: full debug information. [] |
---|
69 | </docuold> |
---|
70 | </docu> |
---|
71 | |
---|
72 | </model> |
---|
73 | <model name="timestat" title="Time satistics" layout="flat"> |
---|
74 | <xor name="opttime" title="Select the Time statistics option (TIMER_debug variable)" default="none"> |
---|
75 | <model name="none" title="0"> |
---|
76 | </model> |
---|
77 | <model name="opt_1" title="1"> |
---|
78 | </model> |
---|
79 | <model name="opt_2" title="2"> |
---|
80 | </model> |
---|
81 | <model name="opt_3" title="3"> |
---|
82 | </model> |
---|
83 | </xor> |
---|
84 | <docu> |
---|
85 | |
---|
86 | [section=Timing files] |
---|
87 | This number refers to the amount of time statistic information written by OASIS3-MCT |
---|
88 | in the "timer" files. In production mode, it should be 0. |
---|
89 | |
---|
90 | When time statistic are needed, it should be 1. |
---|
91 | |
---|
92 | Detailed information about the meaning of each TIMER_debug level can be found in the User |
---|
93 | Guide, section 3.2 (see the NLOGPRT keyword) and section 6.4.2. |
---|
94 | |
---|
95 | <docuold> |
---|
96 | |
---|
97 | The number corresponds to: [] |
---|
98 | 0 : nothing is calculated, nothing is written. [] |
---|
99 | 1 : some timings are performed and written in a single file by the process 0 |
---|
100 | as well as the min and the max times over all the processes. [] |
---|
101 | 2 : some timings are performed and each process writes its own file ; process 0 |
---|
102 | also writes the min and the max times over all the processes in its file. [] |
---|
103 | 3 : some timings are peformed and each process writes its own file ; process 0 |
---|
104 | also writes in its file the min and the max times over all processes and also writes in |
---|
105 | its file all the results for each process.[] |
---|
106 | |
---|
107 | [section=Timing signification] |
---|
108 | The time given for each timer is calculated by the difference between calls to oasis_timer_start() |
---|
109 | and oasis_timer_stop() and is the accumulated time over the entire run. Here is an overview of the |
---|
110 | meaning of the different timers as implemented by default.[] |
---|
111 | |
---|
112 | [item=total after init:] total time of the simulation, implemented in mod_oasis_method, i.e. between |
---|
113 | the end of oasis_init_comp and the call to mpi_barrier and mpi_finalize in routine oasis_terminate. [] |
---|
114 | </docuold> |
---|
115 | </docu> |
---|
116 | |
---|
117 | </model> |
---|
118 | |
---|
119 | <model name="generalgroup" title="Group" layout="flat"> |
---|
120 | <param name="groups_onoff" title="Enable grouped fields" type="onoff" default="0" /> |
---|
121 | <info name="mult_fields_name" title="Group fields names" type="liststring" default="single" visibility="hidden"/> |
---|
122 | <docu> |
---|
123 | [section=Grouping coupling fields] |
---|
124 | OASIS3-MCT supports exchange of multiple fields via a single communication. |
---|
125 | In the component model codes, these fields are defined as usual, and sent (``put'') or received (``get'') |
---|
126 | one at a time. |
---|
127 | |
---|
128 | More details on this new functionality can be found in the User Guide, appendix B.2.4. |
---|
129 | |
---|
130 | To enable grouped fields, the user must activate the option "Enable grouped fields". |
---|
131 | In this case a new tab "Group" will appear to define the different groups. |
---|
132 | |
---|
133 | <docuold> |
---|
134 | Inside OASIS3-MCT, the fields are stored and a |
---|
135 | single mapping and send or receive instruction is in fact executed for all fields. |
---|
136 | This is useful in cases where multiple fields have |
---|
137 | the same coupling transformations and to reduce communication costs by aggregating |
---|
138 | multiple fields into a single communication. |
---|
139 | The coupling fields must be sent and received in the same order as they are defined in the corresponding |
---|
140 | single entry of the namcouple.[] |
---|
141 | Note that if a LOCTRAN transformation is needed for these multiple fields, it is necessary to |
---|
142 | define one restart file per each group of fields. [] |
---|
143 | </docuold> |
---|
144 | </docu> |
---|
145 | </model> |
---|
146 | |
---|