Detailed Description

Solver parameters define options/flags related to the numerical engine, and are typically independent of the physical model evaluation.

See also: SimulationParameter

Definition at line 39 of file NANDRAD_SolverParameter.h.

#include <NANDRAD_SolverParameter.h>

Public Types
enum	para_t { P_RelTol, P_AbsTol, P_MaxTimeStep, P_MinTimeStep, P_InitialTimeStep, P_NonlinSolverConvCoeff, P_IterativeSolverConvCoeff, P_DiscMinDx, P_DiscStretchFactor, P_ViewfactorTileWidth, P_SurfaceDiscretizationDensity, P_ControlTemperatureTolerance, P_KinsolRelTol, P_KinsolAbsTol, NUM_P }
	Parameter. More...

enum	intPara_t { IP_PreILUWidth, IP_MaxKrylovDim, IP_MaxNonlinIter, IP_MaxOrder, IP_KinsolMaxNonlinIter, IP_DiscMaxElementsPerLayer, NUM_IP }
	Integer parameters. More...

enum	flag_t { F_DetectMaxTimeStep, F_KinsolDisableLineSearch, F_KinsolStrictNewton, NUM_F }
	Flags. More...

enum	integrator_t { I_CVODE, I_ExplicitEuler, I_ImplicitEuler, NUM_I }
	Enumeration of available integrators. More...

enum	lesSolver_t { LES_Dense, LES_KLU, LES_GMRES, LES_BiCGStab, NUM_LES }
	Enumeration of available linear equation system (LES) solvers, to be used with implicit integrators.

enum	precond_t { PRE_ILU, NUM_PRE }
	Enumeration of available preconditioners, to be used with iterative LES solvers. More...

Public Member Functions
void	initDefaults ()
	Init default values (called before readXML()). More...

NANDRAD_READWRITE void	checkParameters () const
	To be called after readXML() and mainly used to check whether user-provided parameters are in the valid ranges. More...

Public Attributes
IBK::Parameter	m_para [NUM_P]
	List of parameters. More...

IBK::IntPara	m_intPara [NUM_IP]
	List of integer value parameters. More...

IBK::Flag	m_flag [NUM_F]
	List of flags. More...

integrator_t	m_integrator = NUM_I
	Selected integrator engine. More...

lesSolver_t	m_lesSolver = NUM_LES
	Selected LES solver. More...

precond_t	m_preconditioner = NUM_PRE
	Selected preconditioner. More...

Member Enumeration Documentation

◆ para_t

enum NANDRAD::SolverParameter::para_t

Parameter.

Enumerator
P_RelTol	Relative tolerance for solver error check, default 1e-5.
P_AbsTol	Absolute tolerance for solver error check, default 1e-10.
P_MaxTimeStep	Maximum permitted time step for integration, default 1 h.
P_MinTimeStep	Minimum accepted time step, before solver aborts with error, default 1e-12 s.
P_InitialTimeStep	Initial time step size (or constant step size for ExplicitEuler integrator), default 0.1 s.
P_DiscMinDx	Minimum element width for wall discretization, default 2 mm.
P_DiscStretchFactor	Stretch factor for variable wall discretizations (0-no disc, 1-equidistance, larger than 1 - variable), default 4.

Definition at line 43 of file NANDRAD_SolverParameter.h.

◆ intPara_t

enum NANDRAD::SolverParameter::intPara_t

Integer parameters.

Definition at line 69 of file NANDRAD_SolverParameter.h.

◆ flag_t

enum NANDRAD::SolverParameter::flag_t

Flags.

Definition at line 80 of file NANDRAD_SolverParameter.h.

◆ integrator_t

enum NANDRAD::SolverParameter::integrator_t

Enumeration of available integrators.

Definition at line 88 of file NANDRAD_SolverParameter.h.

◆ precond_t

enum NANDRAD::SolverParameter::precond_t

Enumeration of available preconditioners, to be used with iterative LES solvers.

Definition at line 107 of file NANDRAD_SolverParameter.h.

Member Function Documentation

◆ initDefaults()

void NANDRAD::SolverParameter::initDefaults ( )

Init default values (called before readXML()).

Note: These values will be overwritten in readXML() when the respective property is set in the project file.

◆ checkParameters()

NANDRAD_READWRITE void NANDRAD::SolverParameter::checkParameters ( ) const

To be called after readXML() and mainly used to check whether user-provided parameters are in the valid ranges.

Member Data Documentation

◆ m_para

IBK::Parameter NANDRAD::SolverParameter::m_para[NUM_P]

List of parameters.

Definition at line 130 of file NANDRAD_SolverParameter.h.

◆ m_intPara

IBK::IntPara NANDRAD::SolverParameter::m_intPara[NUM_IP]

List of integer value parameters.

Definition at line 132 of file NANDRAD_SolverParameter.h.

◆ m_flag

IBK::Flag NANDRAD::SolverParameter::m_flag[NUM_F]

List of flags.

Definition at line 134 of file NANDRAD_SolverParameter.h.

◆ m_integrator

integrator_t NANDRAD::SolverParameter::m_integrator = NUM_I

Selected integrator engine.

See also: integrator_t

Definition at line 139 of file NANDRAD_SolverParameter.h.

◆ m_lesSolver

lesSolver_t NANDRAD::SolverParameter::m_lesSolver = NUM_LES

Selected LES solver.

See also: lesSolver_t

Definition at line 144 of file NANDRAD_SolverParameter.h.

◆ m_preconditioner

precond_t NANDRAD::SolverParameter::m_preconditioner = NUM_PRE

Selected preconditioner.

See also: precond_t

Definition at line 149 of file NANDRAD_SolverParameter.h.

The documentation for this class was generated from the following file:

NANDRAD_SolverParameter.h