Keywords introduced by TrioCFD that extend the Schema_temps_base family. See Keywords derived from schema_temps_base for the base-class documentation and the canonical keyword list.
implicit_euler_steady_scheme
Synonyms: schema_euler_implicite_stationnaire
This is the Implicit Euler scheme using a dual time step procedure (using local and global dt) for steady problems. The only possible solver choice for this scheme is the implicit_steady solver. The stationarity criterion checks all equations (velocity, turbulence, temperature, etc.) using the global seuil_statio threshold. For RANS turbulence models (k-epsilon, k-omega), turbulence variables may exhibit persistent low- amplitude oscillations that prevent the stationarity criterion from being reached. In such cases, it is recommended to set nb_pas_dt_max as the primary stopping criterion and monitor residuals manually. The local time step used as pseudo-inertia is dt_loc = steady_security_factor * facsec * dt_CFL. When facsec_max is set to a finite value, facsec grows dynamically (based on residual reduction) up to facsec_max, accelerating convergence similarly to the standard implicit scheme. Without facsec_max, facsec stays fixed at its initial value (default 1). The pseudo-time displayed in outputs (TIME in .dt_ev) equals the iteration count (dt=1 per step), making it comparable across meshes and convection schemes.
Parameters:
- [facsec_max] (type: float) Maximum ratio allowed between local pseudo-time step and stability time returned by the CFL condition; default is 1 (facsec stays fixed). Setting a value greater than 1 enables dynamic facsec growth.
- [max_iter_implicite] (type: int) Maximum number of iterations allowed for the solver (by default 200).
- solveur (type: solveur_implicite_base) This keyword is used to designate the solver selected in the situation where the time scheme is an implicit scheme. solver is the name of the solver that allows equation diffusion and convection operators to be set as implicit terms. Keywords corresponding to this functionality are Simple (SIMPLE type algorithm), Simpler (SIMPLER type algorithm) for incompressible systems, Piso (Pressure Implicit with Split Operator), and Implicite (similar to PISO, but as it looks like a simplified solver, it will use fewer timesteps, and ICE (for PB_multiphase). But it may run faster because the pressure matrix is not re-assembled and thus provides CPU gains. Advice: Since the 1.6.0 version, we recommend to use first the Implicite or Simple, then Piso, and at least Simpler. Because the two first give a fastest convergence (several times) than Piso and the Simpler has not been validated. It seems also than Implicite and Piso schemes give better results than the Simple scheme when the flow is not fully stationary. Thus, if the solution obtained with Simple is not stationary, it is recommended to switch to Piso or Implicite scheme.
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.
rk3_ft
Keyword for Runge Kutta time scheme for Front_Tracking calculation.
Parameters:
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.
schema_cahn_hilliard
Synonyms: scheme_cahn_hilliard
Time-integration scheme for a Cahn-Hilliard problem (semi-implicit Euler specialised for phase-field).
Parameters:
- theta (type: float) Semi-implicit weight (0 = fully explicit, 1 = fully implicit).
- [max_iter_implicite] (type: int) Maximum number of iterations allowed for the solver (by default 200).
- solveur (type: solveur_implicite_base) This keyword is used to designate the solver selected in the situation where the time scheme is an implicit scheme. solver is the name of the solver that allows equation diffusion and convection operators to be set as implicit terms. Keywords corresponding to this functionality are Simple (SIMPLE type algorithm), Simpler (SIMPLER type algorithm) for incompressible systems, Piso (Pressure Implicit with Split Operator), and Implicite (similar to PISO, but as it looks like a simplified solver, it will use fewer timesteps, and ICE (for PB_multiphase). But it may run faster because the pressure matrix is not re-assembled and thus provides CPU gains. Advice: Since the 1.6.0 version, we recommend to use first the Implicite or Simple, then Piso, and at least Simpler. Because the two first give a fastest convergence (several times) than Piso and the Simpler has not been validated. It seems also than Implicite and Piso schemes give better results than the Simple scheme when the flow is not fully stationary. Thus, if the solution obtained with Simple is not stationary, it is recommended to switch to Piso or Implicite scheme.
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.
schema_cahn_hilliard_navier_stokes
Time-integration scheme coupling the semi-implicit Cahn-Hilliard step with a dedicated convection sub-scheme for the Navier-Stokes equation.
Parameters:
- [schema_convection] (type: schema_temps_base) Time sub-scheme used to advance the Navier-Stokes convection (e.g. Runge_Kutta_ordre_3, Schema_Euler_implicite).
- theta (type: float) Semi-implicit weight (0 = fully explicit, 1 = fully implicit).
- [max_iter_implicite] (type: int) Maximum number of iterations allowed for the solver (by default 200).
- solveur (type: solveur_implicite_base) This keyword is used to designate the solver selected in the situation where the time scheme is an implicit scheme. solver is the name of the solver that allows equation diffusion and convection operators to be set as implicit terms. Keywords corresponding to this functionality are Simple (SIMPLE type algorithm), Simpler (SIMPLER type algorithm) for incompressible systems, Piso (Pressure Implicit with Split Operator), and Implicite (similar to PISO, but as it looks like a simplified solver, it will use fewer timesteps, and ICE (for PB_multiphase). But it may run faster because the pressure matrix is not re-assembled and thus provides CPU gains. Advice: Since the 1.6.0 version, we recommend to use first the Implicite or Simple, then Piso, and at least Simpler. Because the two first give a fastest convergence (several times) than Piso and the Simpler has not been validated. It seems also than Implicite and Piso schemes give better results than the Simple scheme when the flow is not fully stationary. Thus, if the solution obtained with Simple is not stationary, it is recommended to switch to Piso or Implicite scheme.
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.
schema_euler_semi_implicite
Synonyms: scheme_euler_semi_implicit
Semi-implicit Euler time-integration scheme (parent of Schema_Cahn_Hilliard).
Parameters:
- theta (type: float) Semi-implicit weight (0 = fully explicit, 1 = fully implicit).
- [max_iter_implicite] (type: int) Maximum number of iterations allowed for the solver (by default 200).
- solveur (type: solveur_implicite_base) This keyword is used to designate the solver selected in the situation where the time scheme is an implicit scheme. solver is the name of the solver that allows equation diffusion and convection operators to be set as implicit terms. Keywords corresponding to this functionality are Simple (SIMPLE type algorithm), Simpler (SIMPLER type algorithm) for incompressible systems, Piso (Pressure Implicit with Split Operator), and Implicite (similar to PISO, but as it looks like a simplified solver, it will use fewer timesteps, and ICE (for PB_multiphase). But it may run faster because the pressure matrix is not re-assembled and thus provides CPU gains. Advice: Since the 1.6.0 version, we recommend to use first the Implicite or Simple, then Piso, and at least Simpler. Because the two first give a fastest convergence (several times) than Piso and the Simpler has not been validated. It seems also than Implicite and Piso schemes give better results than the Simple scheme when the flow is not fully stationary. Thus, if the solution obtained with Simple is not stationary, it is recommended to switch to Piso or Implicite scheme.
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.
schema_phase_field
Keyword for the only available Scheme for time discretization of the Phase Field problem.
Parameters:
- [schema_ch] (type: schema_temps_base) Time scheme for the Cahn-Hilliard equation.
- [schema_ns] (type: schema_temps_base) Time scheme for the Navier-Stokes equation.
- [tinit] (type: float) Value of initial calculation time (0 by default).
- [tmax] (type: float) Time during which the calculation will be stopped (1e30s by default).
- [tcpumax] (type: float) CPU time limit (must be specified in hours) for which the calculation is stopped (1e30s by default).
- [dt_min] (type: float) Minimum calculation time step (1e-16s by default).
- [dt_max] (type: string) Maximum calculation time step as function of time (1e30s by default).
- [dt_sauv] (type: float) Save time step value (1e30s by default). Every dt_sauv, fields are saved in the .sauv file. The file contains all the information saved over time. If this instruction is not entered, results are saved only upon calculation completion. To disable the writing of the .sauv files, you must specify 0. Note that dt_sauv is in terms of physical time (not cpu time).
- [nb_sauv_max] (type: int) Maximum number of timesteps that will be stored in backup file (10 by default). This value is only useful when doing a complete backup of the calculation with parallel PDI (as it needs to allocate the proper amount of dataspace in advance). If this number is reached (ie we already stored the data of nb_sauv_max timesteps in the file), the next checkpoints will overwrite the first ones
- [dt_impr] (type: float) Scheme parameter printing time step in time (1e30s by default). The time steps and the flux balances are printed (incorporated onto every side of processed domains) into the .out file.
- [facsec] (type: string) Value assigned to the safety factor for the time step (1. by default). It can also be a function of time. The time step calculated is multiplied by the safety factor. The first thing to try when a calculation does not converge with an explicit time scheme is to reduce the facsec to 0.5. Warning: Some schemes needs a facsec lower than 1 (0.5 is a good start), for example Schema_Adams_Bashforth_order_3.
- [seuil_statio] (type: float) Value of the convergence threshold (1e-12 by default). Problems using this type of time scheme converge when the derivatives dGi/dt of all the unknown transported values Gi have a combined absolute value less than this value. This is the keyword used to set the permanent rating threshold.
- [residuals] (type: residuals) To specify how the residuals will be computed (default max norm, possible to choose L2-norm instead).
- [diffusion_implicite] (type: int) Keyword to make the diffusive term in the Navier-Stokes equations implicit (in this case, it should be set to 1). The stability time step is then only based on the convection time step (dt=facsec*dt_convection). Thus, in some circumstances, an important gain is achieved with respect to the time step (large diffusion with respect to convection on tightened meshes). Caution: It is however recommended that the user avoids exceeding the convection time step by selecting a too large facsec value. Start with a facsec value of 1 and then increase it gradually if you wish to accelerate calculation. In addition, for a natural convection calculation with a zero initial velocity, in the first time step, the convection time is infinite and therefore dt=facsec*dt_max.
- [seuil_diffusion_implicite] (type: float) This keyword changes the default value (1e-6) of convergency criteria for the resolution by conjugate gradient used for implicit diffusion.
- [impr_diffusion_implicite] (type: int) Unactivate (default) or not the printing of the convergence during the resolution of the conjugate gradient.
- [impr_extremums] (type: int) Print unknowns extremas
- [no_error_if_not_converged_diffusion_implicite] (type: int) not_set
- [no_conv_subiteration_diffusion_implicite] (type: int) not_set
- [dt_start] (type: dt_start) dt_start dt_min : the first iteration is based on dt_min. dt_start dt_calc : the time step at first iteration is calculated in agreement with CFL condition. dt_start dt_fixe value : the first time step is fixed by the user (recommended when resuming calculation with Crank Nicholson temporal scheme to ensure continuity). By default, the first iteration is based on dt_calc.
- [nb_pas_dt_max] (type: int) Maximum number of calculation time steps (1e9 by default).
- [niter_max_diffusion_implicite] (type: int) This keyword changes the default value (number of unknowns) of the maximal iterations number in the conjugate gradient method used for implicit diffusion.
- [precision_impr] (type: int) Optional keyword to define the digit number for flux values printed into .out files (by default 3).
- [periode_sauvegarde_securite_en_heures] (type: float) To change the default period (23 hours) between the save of the fields in .sauv file.
- [no_check_disk_space] (type: flag) To disable the check of the available amount of disk space during the calculation.
- [disable_progress] (type: flag) To disable the writing of the .progress file.
- [disable_dt_ev] (type: flag) To disable the writing of the .dt_ev file.
- [adapt_dt_tmax] (type: flag) Use to adapt final dt when approaching tmax.
- [gnuplot_header] (type: int) Optional keyword to modify the header of the .out files. Allows to use the column title instead of columns number.