Différences

Ci-dessous, les différences entre deux révisions de la page.

--- sunfluidh:simulation_management_setup_namelist [2019/11/13 15:39] – yann
+++ sunfluidh:simulation_management_setup_namelist [2022/01/10 10:34] (Version actuelle) – yann
@@ Ligne 4: / Ligne 4: @@
   * record the results associated to time series of probes, instantaneous physical quantity fields, statistical quantities.
   * record the backup/restart files
 ===== Full data set of the namelist =====
-   &Simulation_Management    Restart_Parameter= 0 ,
+   &Simulation_Management
-                             Steady_Flow_Stopping_Criterion_Enabled = .false. ,
-                             Steady_Flow_Stopping_Criterion = 1.D-20,
+   !------------------------------------------------
-                             Temporal_Iterations_Number = 10                  ,
+   !--- Restart the simulation
-                             Final_Time = 3.D+01  ,
+   !------------------------------------------------
-                             TimeStep_Type = 0 ,
+      Restart_Parameter= 0 ,
-                             Timestep_Min = 1.D-03                           ,
+   !------------------------------------------------
-                             Timestep_Max = 1.D-03 ,
+   !--- Stopping criteria
-                             CFL_Min      = 0.5                              ,
+   !------------------------------------------------
-                             CFL_Max      = 0.5 ,
+      Steady_Flow_Stopping_Criterion_Enabled = .false. ,
-                             Iterations_For_Timestep_Linear_Progress= 1,
+      Steady_Flow_Stopping_Criterion = 1.D-20,
-                             Simulation_Backup_Rate                 = 1000   ,
+      Temporal_Iterations_Number = 10                  ,
-                             Simulation_Checking_Rate = 200 ,
+      Final_Time = 3.D+01  ,
-                             InstantaneousFields_TimeRecordingRate= 1.0D+00  ,
+   !------------------------------------------------
-                             InstantaneousFields_RecordingStartTime= 0.0    ,
+   !--- Numerical time step
-                             Probe_StartTimeIterationRecording= 20          ,
+   !------------------------------------------------
-                             Probe_TimeIterationRecordingRate      = 10     ,
+      TimeStep_Type = 0 ,
-                             Start_Time_For_Statistics= 1.D+2               ,
+      Timestep_Min = 1.D-03                           ,
-                             Time_Range_Statistic_Calculation = 1.D+00  /
+      Timestep_Max = 1.D-03 ,
+      CFL_Min      = 0.5                              ,
+      CFL_Max      = 0.5 ,
+      Iterations_For_Timestep_Linear_Progress= 1 ,
+   !------------------------------------------------
+   !--- Recording rates for different kind of files
+   !------------------------------------------------
+    !--- Backup++/Restart files
+      Simulation_Backup_Rate   = 1000   ,
+    !--- checkcalc_xxxxxx.d file
+      Simulation_Checking_Rate = 200 ,
+    !--- Snapshots
+      InstantaneousFields_RecordingReset=.false. ,
+      InstantaneousFields_TimeRecordingRate= 1.0D+00  ,    !--- in time units
+      InstantaneousFields_RecordingStartTime= 0.0    ,     !--- in time units
+      InstantaneousFields_TimeIterationRecordingRate= 10,  !--- in time-step iteration unit
+      InstantaneousFields_StartTimeIterationRecording= 70, !--- in time-step iteration unit
+    !--- Probe time series files
+      Probe_RecordingReset=.false. ,
+      Probe_StartTimeIterationRecording= 20          ,  !--- in time-iteration units
+      Probe_TimeIterationRecordingRate      = 10     ,  !--- in time-iteration units
+    !--- Slice files
+      Slices_RecordingReset=.false. ,
+     !Slices_TimeRecordingRate= 5.0E-01  ,        !--- in time units
+     !Slices_RecordingStartTime= 1.D-00   ,       !--- in time units
+      Slices_TimeIterationRecordingRate= 10  ,    !---  in time-step iteration unit
+      Slices_StartTimeIterationRecording= 50 ,    !---  in time-step iteration unit
+    !--- Space-averaged field files
+      SpaceAveragedFields_RecordingReset=.false. ,
+     !SpaceAveragedFields_TimeRecordingRate= 5.0E-01 ,      !--- in time units
+     !SpaceAveragedFields_RecordingStartTime= 1.D-00  ,     !--- in time units
+      SpaceAveragedFields_TimeIterationRecordingRate= 10  , !--- in time-step iteration units
+      SpaceAveragedFields_StartTimeIterationRecording= 20 , !--- in time-step iteration units
+    !--- Statistics files
+      Start_Time_For_Statistics= 1.D+2               ,      !--- in time units
+      Time_Range_Statistic_Calculation = 1.D+00             !--- in time units
+      /
+===== Split the namelist =====
+<note>
+As the number of data in this namelist can be large and bounded to different types of functionnalities (probes, instananeous fields, statistical quantities, simulation parameters, ...), the full dataset of this namelist can be split into several parts in the input data file. Each part is defined with the same namelist name ("Simulation_Management") but each dataset must be different.
+</note>
+    &Simulation_Management
+    !--- Snapshots
+      InstantaneousFields_RecordingReset=.false. ,
+      InstantaneousFields_TimeRecordingRate= 1.0D+00  ,    !--- in time units
+      InstantaneousFields_RecordingStartTime= 0.0    ,     !--- in time units
+      InstantaneousFields_TimeIterationRecordingRate= 10,  !--- in time-step iteration unit
+      InstantaneousFields_StartTimeIterationRecording= 70, !--- in time-step iteration unit
+    /
+    &Simulation_Management
+    !--- Probe time series files
+      Probe_RecordingReset=.false. ,
+      Probe_StartTimeIterationRecording= 20          ,  !--- in time-iteration units
+      Probe_TimeIterationRecordingRate      = 10     ,  !--- in time-iteration units
+    /
+    &Simulation_Management
+    !--- Slice files
+      Slices_RecordingReset=.false. ,
+     !Slices_TimeRecordingRate= 5.0E-01  ,        !--- in time units
+     !Slices_RecordingStartTime= 1.D-00   ,       !--- in time units
+      Slices_TimeIterationRecordingRate= 10  ,    !---  in time-step iteration unit
+      Slices_StartTimeIterationRecording= 50 ,    !---  in time-step iteration unit
+      /
+      &Simulation_Management
+    !--- Space-averaged field files
+      SpaceAveragedFields_RecordingReset=.false. ,
+     !SpaceAveragedFields_TimeRecordingRate= 5.0E-01 ,      !--- in time units
+     !SpaceAveragedFields_RecordingStartTime= 1.D-00  ,     !--- in time units
+      SpaceAveragedFields_TimeIterationRecordingRate= 10  , !--- in time-step iteration units
+      SpaceAveragedFields_StartTimeIterationRecording= 20 , !--- in time-step iteration units
+     /
+     &Simulation_Management
+    !--- Statistics files
+      Start_Time_For_Statistics= 1.D+2               ,      !--- in time units
+      Time_Range_Statistic_Calculation = 1.D+00             !--- in time units
+      /
 -----
@@ Ligne 62: / Ligne 173: @@
 The simulation stops as soon as one of these conditions is achieved.
 </note>
+   &Simulation_Management
+   !------------------------------------------------
+   !--- Restart the simulation
+   !------------------------------------------------
+      Restart_Parameter= 0 ,
+   !------------------------------------------------
+   !--- Stopping criteria
+   !------------------------------------------------
+      Steady_Flow_Stopping_Criterion_Enabled = .false. ,
+      Steady_Flow_Stopping_Criterion = 1.D-20,
+      Temporal_Iterations_Number = 10                  ,
+      Final_Time = 3.D+01  ,
+   !------------------------------------------------
+   !--- Numerical time step
+   !------------------------------------------------
+      TimeStep_Type = 0 ,
+      Timestep_Min = 1.D-03                           ,
+      Timestep_Max = 1.D-03 ,
+      CFL_Min      = 0.5                              ,
+      CFL_Max      = 0.5 ,
+      Iterations_For_Timestep_Linear_Progress= 1 /
 ----
@@ Ligne 138: / Ligne 272: @@
 <WRAP important>
- This set of variables must be used in respect of one rule : the user wants to define the recording rate of files either in time unit or in number of time steps (time-ieration unit). In any case, the correct couple of variable must be used.
+ This set of variables must be used in respect of one rule : the recording rate of files is defined either in time unit or in number of time steps (time-ieration unit). In any case, the correct couple of variables must be used.
-   * "InstantaneousFields_RecordingStartTime" and "InstantaneousFields_TimeRecordingRate" in  time unit.
+   * "InstantaneousFields_RecordingStartTime" and "InstantaneousFields_TimeRecordingRate" (in time unit).
-   * "InstantaneousFields_StartTimeIterationRecording" and "InstantaneousFields_TimeIterationRecordingRate" in number of time steps.
+   * "InstantaneousFields_StartTimeIterationRecording" and "InstantaneousFields_TimeIterationRecordingRate" (in number of time steps).
 </WRAP>
+==== - For slice files (instantaneous fields recorded on a slice): ====
+**Slices_RecordingStartTime**
+   * Type : Real value
+   * This variable sets the time threshold from which the record of instantaneous fields begins. It must be used along with the next variable "Slices_TimeRecordingRate". This value is defined in time unit.
+**Slices_StartTimeIterationRecording**
+   * Type : Integer value
+   * This variable sets the time-iteration threshold from which the record of instantaneous fields on slices begins. It must be used along with the next variable "Slices_TimeIterationRecordingRate". This value is defined in time-iteration unit (number of time steps).
+**Slices_TimeIterationRecordingRate**
+   * Type : Integer value
+   * This variable defines the recording rate, __in time-iteration units__ , of instantaneous fields on slices. For instance, when "Slices_TimeIterationRecordingRate=100" a file is created at every 100 time steps from the threshold provided by the variable "Slices_StartTimeIterationRecording".\\
+**Slices_RecordingReset**
+   * Type : Boolean value. The default value is .false.
+   * When this variable is set to ".true.", the ID number of file 'xxxxxxx' is set to zero for the next simulation. This is useful for resetting the file numbering when a simulation is split into several successive parts.
+<note>
+Keep in mind :
+   * For instantaneous field on slice, the files are named slice_Id_dir_xxxxxxx_yyyyy.d.
+   * Id is the ID number of the Slice.
+   * dir specifies the direction of the slice
+   * The number 'yyyyy' stands for the subdomain number on which fields are recorded for simulations based on the MPI domain-decomposition approach. When the domain decomposition approach is not used (just one domain), 'yyyyy=00000' is the default value. This number is not present if the option "Slice_Gathering_Enabled" is set to "true" in the namelist "Field_Recording_Setup" because every pieces of slice split over several subdomain are gathered in the same file.
+   *  'xxxxxxx' is the ID number of the file. 'xxxxxxx' is incremented by one for each new file created.
+   * The instantaneous fields of the physical quantities written in each file are defined with the namelist "Slice_Recording_Setup".
+</note>
+==== - For space-averaged field files (instantaneous fields integrated in space along a direction): ====
+**SpaceAveragedFields_RecordingStartTime**
+   * Type : Real value
+   * This variable sets the time threshold from which the record of space-averaged fields begins. It must be used along with the next variable "SpaceAveragedFields_TimeRecordingRate". This value is defined in time unit.
+**SpaceAveragedFields_StartTimeIterationRecording**
+   * Type : Integer value
+   * This variable sets the time-iteration threshold from which the record of space-averaged fields begins. It must be used along with the next variable "SpaceAveragedFields_TimeIterationRecordingRate". This value is defined in time-iteration unit (number of time steps).
+**SpaceAveragedFields_TimeIterationRecordingRate**
+   * Type : Integer value
+   * This variable defines the recording rate, __in time-iteration units__ , of instantaneous fields on slices. For instance, when "SpaceAveragedFields_TimeIterationRecordingRate=100" a file is created at every 100 time steps from the threshold provided by the variable "SpaceAveragedFields_StartTimeIterationRecording".\\
+**SpaceAveragedFields_RecordingReset**
+   * Type : Boolean value. The default value is .false.
+   * When this variable is set to ".true.", the ID number of file 'xxxxxxx' is set to zero for the next simulation. This is useful for resetting the file numbering when a simulation is split into several successive parts.
+<note>
+Keep in mind :
+   * For space-averaged field along a specific direction, the files are named spav_Id_dir_xxxxxxx_yyyyy.d.
+   * Id is the ID number of the Slice.
+   * dir specifies the direction of the slice
+   * The number 'yyyyy' stands for the subdomain number on which fields are recorded for simulations based on the MPI domain-decomposition approach. When the domain decomposition approach is not used (just one domain), 'yyyyy=00000' is the default value. This number is not present if the option "Slice_Gathering_Enabled" is set to "true" in the namelist "Field_Recording_Setup" because every fields split over several subdomain are gathered in the same file.
+   *  'xxxxxxx' is the ID number of the file. 'xxxxxxx' is incremented by one for each new file created.
+   * The space-averaged fields written in each file are defined with the namelist "SpaceAveragedSnapshots_Dataset".
+</note>
 ==== - For statistics files : ====
@@ Ligne 159: / Ligne 349: @@
    * This variable defines the recording rate, __in time iteration unit__ (number of time steps), of time series from probes distributed over the domain (see the namelist "Probe_Location"). The physical quantities linked to the probe time-series are defined with the namelist "Probe_Quantities_Enabled". For instance, when "Probe_TimeIterationRecordingRate=10", a new value is added to probe time-series at every 10 time steps from the threshold defined with "Probe_StartTimeIterationRecording").
-**Probe_TimeIterationRecordingRate**
+**Probe_StartTimeIterationRecording**
    * Type : Integer value
    * This variable defines the threshold from which the probe time-series start (in time iteration unit)