https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
LinearAssemblySegregatedSolve Class Reference

Common base class for segregated solvers for the Navier-Stokes equations with linear FV assembly routines. More...

#include <LinearAssemblySegregatedSolve.h>

Inheritance diagram for LinearAssemblySegregatedSolve:
[legend]

Classes

struct  ResidualStorage
 Aggregated storage for residuals, tolerances, and indices used in convergence checks. More...
 

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 LinearAssemblySegregatedSolve (Executioner &ex)
 
virtual void linkRhieChowUserObject () override
 Fetch the Rhie Chow user object that is reponsible for determining face velocities and mass flux.
 
virtual void initialSetup () override
 
virtual bool solve () override
 Performs the momentum pressure coupling.
 
const std::vector< LinearSystem * > systemsToSolve () const
 Return pointers to the systems which are solved for within this object.
 
virtual void setInnerSolve (SolveObject &) override
 
void setupPressurePin ()
 Setup pressure pin if there is need for one.
 
virtual void checkIntegrity ()
 Check if the user defined time kernels.
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraph & perfGraph ()
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

virtual std::vector< std::pair< unsigned int, Real > > solveMomentumPredictor () override
 Solve a momentum predictor step with a fixed pressure field.
 
virtual std::pair< unsigned int, Real > solvePressureCorrector () override
 Solve a pressure corrector step.
 
virtual std::pair< unsigned int, Real > correctVelocity (const bool subtract_updated_pressure, const bool recompute_face_mass_flux, const SolverParams &solver_params)
 Computes new velocity field based on computed pressure gradients.
 
std::pair< unsigned int, Real > solveAdvectedSystem (const unsigned int system_num, LinearSystem &system, const Real relaxation_factor, libMesh::SolverConfiguration &solver_config, const Real abs_tol, const Real field_relaxation=1.0, const Real min_value_limiter=std::numeric_limits< Real >::min())
 Solve an equation which contains an advection term that depends on the solution of the segregated Navier-Stokes equations.
 
ResidualStorage setupResidualStorage () const
 Build residual/tolerance vectors and associated indices for all enabled systems.
 
std::pair< unsigned int, Real > solveSolidEnergy ()
 Solve an equation which contains the solid energy conservation.
 
void checkDependentParameterError (const std::string &main_parameter, const std::vector< std::string > &dependent_parameters, const bool should_be_defined)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) const
 

Protected Attributes

std::vector< unsigned int > _momentum_system_numbers
 The number(s) of the system(s) corresponding to the momentum equation(s)
 
std::vector< LinearSystem * > _momentum_systems
 Pointer(s) to the system(s) corresponding to the momentum equation(s)
 
const unsigned int _pressure_sys_number
 The number of the system corresponding to the pressure equation.
 
LinearSystem & _pressure_system
 Reference to the linear system corresponding to the pressure equation.
 
const unsigned int _pressure_pc_recompute_frequency
 How often (in pressure corrector solves) to recompute the pressure preconditioner.
 
unsigned int _pressure_pc_solve_counter
 Number of pressure corrector solves performed since the start of the current SIMPLE solve, used together with _pressure_pc_recompute_frequency to decide when to reuse the preconditioner.
 
const unsigned int _energy_sys_number
 The number of the system corresponding to the energy equation.
 
LinearSystem * _energy_system
 Pointer to the linear system corresponding to the fluid energy equation.
 
const unsigned int _solid_energy_sys_number
 The number of the system corresponding to the solid energy equation.
 
LinearSystem * _solid_energy_system
 Pointer to the linear system corresponding to the solid energy equation.
 
std::vector< LinearSystem * > _passive_scalar_systems
 Pointer(s) to the system(s) corresponding to the passive scalar equation(s)
 
std::vector< LinearSystem * > _pm_radiation_systems
 Pointer(s) to the system(s) corresponding to the participting media radiation equation(s)
 
std::vector< LinearSystem * > _active_scalar_systems
 Pointer(s) to the system(s) corresponding to the active scalar equation(s)
 
std::vector< LinearSystem * > _turbulence_systems
 Pointer(s) to the system(s) corresponding to the turbulence equation(s)
 
RhieChowMassFlux * _rc_uo
 Pointer to the segregated RhieChow interpolation object.
 
std::vector< LinearSystem * > _systems_to_solve
 Shortcut to every linear system that we solve for here.
 
const bool _should_solve_momentum
 Flags controlling which systems are actively solved (can be used with restart to freeze flow)
 
const bool _should_solve_pressure
 
const bool _should_solve_energy
 
const bool _should_solve_solid_energy
 
const bool _should_solve_turbulence
 
const bool _should_solve_passive_scalars
 
const bool _should_solve_active_scalars
 
const bool _should_solve_pm_radiation
 
const std::vector< SolverSystemName > & _active_scalar_system_names
 The names of the active scalar systems.
 
const bool _has_active_scalar_systems
 Boolean for easy check if a active scalar systems shall be solved or not.
 
std::vector< unsigned int > _active_scalar_system_numbers
 
const std::vector< Real > _active_scalar_equation_relaxation
 The user-defined relaxation parameter(s) for the active scalar equation(s)
 
Moose::PetscSupport::PetscOptions _active_scalar_petsc_options
 Options which hold the petsc settings for the active scalar equation(s)
 
SIMPLESolverConfiguration _active_scalar_linear_control
 Options for the linear solver of the active scalar equation(s)
 
const Real _active_scalar_l_abs_tol
 Absolute linear tolerance for the active scalar equation(s).
 
const std::vector< Real > _active_scalar_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in active scalars.
 
NS::FV::CHTHandler _cht
 ********************** Conjugate heat transfer variables ************** //
 
const std::vector< SolverSystemName > & _momentum_system_names
 The names of the momentum systems.
 
SIMPLESolverConfiguration _momentum_linear_control
 Options for the linear solver of the momentum equation.
 
const Real _momentum_l_abs_tol
 Absolute linear tolerance for the momentum equation(s).
 
Moose::PetscSupport::PetscOptions _momentum_petsc_options
 Options which hold the petsc settings for the momentum equation.
 
const Real _momentum_equation_relaxation
 The user-defined relaxation parameter for the momentum equation.
 
const SolverSystemName & _pressure_system_name
 The name of the pressure system.
 
SIMPLESolverConfiguration _pressure_linear_control
 Options for the linear solver of the pressure equation.
 
const Real _pressure_l_abs_tol
 Absolute linear tolerance for the pressure equation.
 
Moose::PetscSupport::PetscOptions _pressure_petsc_options
 Options which hold the petsc settings for the pressure equation.
 
const Real _pressure_variable_relaxation
 The user-defined relaxation parameter for the pressure variable.
 
const bool _pin_pressure
 If the pressure needs to be pinned.
 
const Real _pressure_pin_value
 The value we want to enforce for pressure.
 
dof_id_type _pressure_pin_dof
 The dof ID where the pressure needs to be pinned.
 
const bool _has_energy_system
 Boolean for easy check if a fluid energy system shall be solved or not.
 
const Real _energy_equation_relaxation
 The user-defined relaxation parameter for the energy equation.
 
Moose::PetscSupport::PetscOptions _energy_petsc_options
 Options which hold the petsc settings for the fluid energy equation.
 
SIMPLESolverConfiguration _energy_linear_control
 Options for the linear solver of the energy equation.
 
const Real _energy_l_abs_tol
 Absolute linear tolerance for the energy equations.
 
const bool _has_solid_energy_system
 Boolean for easy check if a solid energy system shall be solved or not.
 
Moose::PetscSupport::PetscOptions _solid_energy_petsc_options
 Options which hold the petsc settings for the fluid energy equation.
 
SIMPLESolverConfiguration _solid_energy_linear_control
 Options for the linear solver of the energy equation.
 
const Real _solid_energy_l_abs_tol
 Absolute linear tolerance for the energy equations.
 
const std::vector< SolverSystemName > & _passive_scalar_system_names
 The names of the passive scalar systems.
 
const bool _has_passive_scalar_systems
 Boolean for easy check if a passive scalar systems shall be solved or not.
 
std::vector< unsigned int > _passive_scalar_system_numbers
 
const std::vector< Real > _passive_scalar_equation_relaxation
 The user-defined relaxation parameter(s) for the passive scalar equation(s)
 
Moose::PetscSupport::PetscOptions _passive_scalar_petsc_options
 Options which hold the petsc settings for the passive scalar equation(s)
 
SIMPLESolverConfiguration _passive_scalar_linear_control
 Options for the linear solver of the passive scalar equation(s)
 
const Real _passive_scalar_l_abs_tol
 Absolute linear tolerance for the passive scalar equation(s).
 
const std::vector< SolverSystemName > & _pm_radiation_system_names
 The names of the participating media radiation systems.
 
const bool _has_pm_radiation_systems
 Boolean for easy check if participating media radiation systems shall be solved or not.
 
std::vector< unsigned int > _pm_radiation_system_numbers
 
const std::vector< Real > _pm_radiation_equation_relaxation
 The user-defined relaxation parameter(s) for the participating media radiation equation(s)
 
Moose::PetscSupport::PetscOptions _pm_radiation_petsc_options
 Options which hold the petsc settings for the participating media radiation equation(s)
 
SIMPLESolverConfiguration _pm_radiation_linear_control
 Options for the linear solver of the participating media radiation equation(s)
 
const Real _pm_radiation_l_abs_tol
 Absolute linear tolerance for the participating media radiation equation(s).
 
const std::vector< SolverSystemName > & _turbulence_system_names
 The names of the turbulence systems.
 
const bool _has_turbulence_systems
 Boolean for easy check if a turbulence scalar systems shall be solved or not.
 
std::vector< unsigned int > _turbulence_system_numbers
 
const std::vector< Real > _turbulence_equation_relaxation
 The user-defined relaxation parameter(s) for the turbulence equation(s)
 
std::vector< Real > _turbulence_field_relaxation
 The user-defined relaxation parameter(s) for the turbulence field(s)
 
std::vector< Real > _turbulence_field_min_limit
 The user-defined lower limit for turbulent quantities e.g. k, eps/omega, etc..
 
Moose::PetscSupport::PetscOptions _turbulence_petsc_options
 Options which hold the petsc settings for the turbulence equation(s)
 
SIMPLESolverConfiguration _turbulence_linear_control
 Options for the linear solver of the turbulence equation(s)
 
const Real _turbulence_l_abs_tol
 Absolute linear tolerance for the turbulence equation(s).
 
const Real _momentum_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in momentum.
 
const Real _pressure_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in pressure.
 
const Real _energy_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in energy.
 
const Real _solid_energy_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in solid energy.
 
const std::vector< Real > _passive_scalar_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in passive scalars.
 
const std::vector< Real > _pm_radiation_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence in participating media radiation.
 
const std::vector< Real > _turbulence_absolute_tolerance
 The user-defined absolute tolerance for determining the convergence turbulence variables.
 
const unsigned int _num_iterations
 The maximum number of momentum-pressure iterations.
 
const bool _continue_on_max_its
 If solve should continue if maximum number of iterations is hit.
 
const bool _print_fields
 Debug parameter which allows printing the coupling and solution vectors/matrices.
 
Executioner & _executioner
 
FEProblemBase & _problem
 
DisplacedProblem * _displaced_problem
 
MooseMesh & _mesh
 
MooseMesh * _displaced_mesh
 
SystemBase & _solver_sys
 
AuxiliarySystem & _aux
 
SolveObject * _inner_solve
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 

Detailed Description

Common base class for segregated solvers for the Navier-Stokes equations with linear FV assembly routines.

Once the nonlinear assembly-based routines are retired, this will be the primary base class instead of SIMPLESolveBase.

Definition at line 23 of file LinearAssemblySegregatedSolve.h.

Constructor & Destructor Documentation

◆ LinearAssemblySegregatedSolve()

LinearAssemblySegregatedSolve::LinearAssemblySegregatedSolve ( Executioner &  ex)

Definition at line 126 of file LinearAssemblySegregatedSolve.C.

127 : SIMPLESolveBase(ex),
128 _pressure_sys_number(_problem.linearSysNum(getParam<SolverSystemName>("pressure_system"))),
129 _pressure_system(_problem.getLinearSystem(_pressure_sys_number)),
130 _pressure_pc_recompute_frequency(getParam<unsigned int>("pressure_pc_recompute_frequency")),
131 _pressure_pc_solve_counter(0),
132 _energy_sys_number(_has_energy_system
133 ? _problem.linearSysNum(getParam<SolverSystemName>("energy_system"))
134 : libMesh::invalid_uint),
135 _energy_system(_has_energy_system ? &_problem.getLinearSystem(_energy_sys_number) : nullptr),
136 _solid_energy_sys_number(
137 _has_solid_energy_system
138 ? _problem.linearSysNum(getParam<SolverSystemName>("solid_energy_system"))
139 : libMesh::invalid_uint),
140 _solid_energy_system(
141 _has_solid_energy_system ? &_problem.getLinearSystem(_solid_energy_sys_number) : nullptr),
142 _should_solve_momentum(getParam<bool>("should_solve_momentum")),
143 _should_solve_pressure(getParam<bool>("should_solve_pressure")),
144 _should_solve_energy(getParam<bool>("should_solve_energy")),
145 _should_solve_solid_energy(getParam<bool>("should_solve_solid_energy")),
146 _should_solve_turbulence(getParam<bool>("should_solve_turbulence")),
147 _should_solve_passive_scalars(getParam<bool>("should_solve_passive_scalars")),
148 _should_solve_active_scalars(getParam<bool>("should_solve_active_scalars")),
149 _should_solve_pm_radiation(getParam<bool>("should_solve_pm_radiation")),
150 _active_scalar_system_names(getParam<std::vector<SolverSystemName>>("active_scalar_systems")),
151 _has_active_scalar_systems(!_active_scalar_system_names.empty()),
152 _active_scalar_equation_relaxation(
153 getParam<std::vector<Real>>("active_scalar_equation_relaxation")),
154 _active_scalar_l_abs_tol(getParam<Real>("active_scalar_l_abs_tol")),
155 _active_scalar_absolute_tolerance(
156 getParam<std::vector<Real>>("active_scalar_absolute_tolerance")),
157 _cht(ex.parameters())
158{
159 if (!_should_solve_momentum && _should_solve_pressure)
160 paramError("should_solve_momentum",
161 "Pressure correction requires solving the momentum equations.");
162 if (_should_solve_momentum && !_should_solve_pressure)
163 paramError("should_solve_pressure",
164 "Solving momentum without a pressure corrector is not supported.");
165 if (_has_solid_energy_system && !_should_solve_energy && _should_solve_solid_energy)
166 paramError("should_solve_solid_energy",
167 "Solid energy solve cannot be enabled when the fluid energy solve is disabled.");
168
169 // We fetch the systems and their numbers for the momentum equations only if we solve them
170 if (_should_solve_momentum)
171 for (auto system_i : index_range(_momentum_system_names))
172 {
173 _momentum_system_numbers.push_back(_problem.linearSysNum(_momentum_system_names[system_i]));
174 _momentum_systems.push_back(&_problem.getLinearSystem(_momentum_system_numbers[system_i]));
175 _systems_to_solve.push_back(_momentum_systems.back());
176 }
177
178 if (_should_solve_pressure)
179 _systems_to_solve.push_back(&_pressure_system);
180
181 if (_has_energy_system && _should_solve_energy)
182 _systems_to_solve.push_back(_energy_system);
183
184 if (_has_solid_energy_system && _should_solve_solid_energy)
185 _systems_to_solve.push_back(_solid_energy_system);
186 // and for the turbulence surrogate equations
187 if (_has_turbulence_systems && _should_solve_turbulence)
188 for (auto system_i : index_range(_turbulence_system_names))
189 {
190 _turbulence_system_numbers.push_back(
191 _problem.linearSysNum(_turbulence_system_names[system_i]));
192 _turbulence_systems.push_back(
193 &_problem.getLinearSystem(_turbulence_system_numbers[system_i]));
194 }
195
196 // and for the passive scalar equations
197 if (_has_passive_scalar_systems && _should_solve_passive_scalars)
198 for (auto system_i : index_range(_passive_scalar_system_names))
199 {
200 _passive_scalar_system_numbers.push_back(
201 _problem.linearSysNum(_passive_scalar_system_names[system_i]));
202 _passive_scalar_systems.push_back(
203 &_problem.getLinearSystem(_passive_scalar_system_numbers[system_i]));
204 if (_should_solve_passive_scalars)
205 _systems_to_solve.push_back(_passive_scalar_systems.back());
206 }
207
208 // and for the participating media radiation equations
209 if (_has_pm_radiation_systems && _should_solve_pm_radiation)
210 for (auto system_i : index_range(_pm_radiation_system_names))
211 {
212 _pm_radiation_system_numbers.push_back(
213 _problem.linearSysNum(_pm_radiation_system_names[system_i]));
214 _pm_radiation_systems.push_back(
215 &_problem.getLinearSystem(_pm_radiation_system_numbers[system_i]));
216 _systems_to_solve.push_back(_pm_radiation_systems.back());
217 }
218
219 // and for the active scalar equations
220 if (_has_active_scalar_systems && _should_solve_active_scalars)
221 for (auto system_i : index_range(_active_scalar_system_names))
222 {
223 _active_scalar_system_numbers.push_back(
224 _problem.linearSysNum(_active_scalar_system_names[system_i]));
225 _active_scalar_systems.push_back(
226 &_problem.getLinearSystem(_active_scalar_system_numbers[system_i]));
227 _systems_to_solve.push_back(_active_scalar_systems.back());
228
229 const auto & active_scalar_petsc_options =
230 getParam<MultiMooseEnum>("active_scalar_petsc_options");
231 const auto & active_scalar_petsc_pair_options = getParam<MooseEnumItem, std::string>(
232 "active_scalar_petsc_options_iname", "active_scalar_petsc_options_value");
233 Moose::PetscSupport::addPetscFlagsToPetscOptions(
234 active_scalar_petsc_options, "", *this, _active_scalar_petsc_options);
235 Moose::PetscSupport::addPetscPairsToPetscOptions(active_scalar_petsc_pair_options,
236 _problem.mesh().dimension(),
237 "",
238 *this,
239 _active_scalar_petsc_options);
240
241 _active_scalar_linear_control.real_valued_data["rel_tol"] =
242 getParam<Real>("active_scalar_l_tol");
243 _active_scalar_linear_control.real_valued_data["abs_tol"] =
244 getParam<Real>("active_scalar_l_abs_tol");
245 _active_scalar_linear_control.int_valued_data["max_its"] =
246 getParam<unsigned int>("active_scalar_l_max_its");
247 }
248
249 if (_active_scalar_equation_relaxation.size() != _active_scalar_system_names.size())
250 paramError("active_scalar_equation_relaxation",
251 "Should be the same size as the number of systems");
252
253 // We disable the prefix here for the time being, the segregated solvers use a different approach
254 // for setting the petsc parameters
255 for (auto & system : _systems_to_solve)
256 system->system().prefix_with_name(false);
257
258 // Link CHT objects, this will also do some error checking
259 // Make a copy for compatibility. These could change in the future
260 // Convert _pm_radiation_systems to std::vector<SystemBase *>
261 if (_cht.enabled())
262 {
263 if (!_should_solve_energy)
264 paramError("should_solve_energy",
265 "Conjugate heat transfer requires solving the fluid energy equation.");
266 if (_has_solid_energy_system && !_should_solve_solid_energy)
267 paramError("should_solve_solid_energy",
268 "Conjugate heat transfer requires solving the solid energy equation.");
269
270 std::vector<SystemBase *> pm_radiation_systems_base(_pm_radiation_systems.begin(),
271 _pm_radiation_systems.end());
272
273 _cht.linkEnergySystems(_solid_energy_system, _energy_system, pm_radiation_systems_base);
274 }
275}
FEProblemBase::getLinearSystem
LinearSystem & getLinearSystem(unsigned int sys_num)
FEProblemBase::linearSysNum
unsigned int linearSysNum(const LinearSystemName &linear_sys_name) const override
FEProblemBase::mesh
virtual MooseMesh & mesh() override
LinearAssemblySegregatedSolve::_energy_sys_number
const unsigned int _energy_sys_number
The number of the system corresponding to the energy equation.
Definition LinearAssemblySegregatedSolve.h:133
LinearAssemblySegregatedSolve::_active_scalar_linear_control
SIMPLESolverConfiguration _active_scalar_linear_control
Options for the linear solver of the active scalar equation(s)
Definition LinearAssemblySegregatedSolve.h:190
LinearAssemblySegregatedSolve::_solid_energy_sys_number
const unsigned int _solid_energy_sys_number
The number of the system corresponding to the solid energy equation.
Definition LinearAssemblySegregatedSolve.h:139
LinearAssemblySegregatedSolve::_systems_to_solve
std::vector< LinearSystem * > _systems_to_solve
Shortcut to every linear system that we solve for here.
Definition LinearAssemblySegregatedSolve.h:160
LinearAssemblySegregatedSolve::_active_scalar_l_abs_tol
const Real _active_scalar_l_abs_tol
Absolute linear tolerance for the active scalar equation(s).
Definition LinearAssemblySegregatedSolve.h:194
LinearAssemblySegregatedSolve::_energy_system
LinearSystem * _energy_system
Pointer to the linear system corresponding to the fluid energy equation.
Definition LinearAssemblySegregatedSolve.h:136
LinearAssemblySegregatedSolve::_cht
NS::FV::CHTHandler _cht
********************** Conjugate heat transfer variables ************** //
Definition LinearAssemblySegregatedSolve.h:202
LinearAssemblySegregatedSolve::_solid_energy_system
LinearSystem * _solid_energy_system
Pointer to the linear system corresponding to the solid energy equation.
Definition LinearAssemblySegregatedSolve.h:142
LinearAssemblySegregatedSolve::_momentum_system_numbers
std::vector< unsigned int > _momentum_system_numbers
The number(s) of the system(s) corresponding to the momentum equation(s)
Definition LinearAssemblySegregatedSolve.h:110
LinearAssemblySegregatedSolve::_turbulence_systems
std::vector< LinearSystem * > _turbulence_systems
Pointer(s) to the system(s) corresponding to the turbulence equation(s)
Definition LinearAssemblySegregatedSolve.h:154
LinearAssemblySegregatedSolve::_momentum_systems
std::vector< LinearSystem * > _momentum_systems
Pointer(s) to the system(s) corresponding to the momentum equation(s)
Definition LinearAssemblySegregatedSolve.h:113
LinearAssemblySegregatedSolve::_pm_radiation_systems
std::vector< LinearSystem * > _pm_radiation_systems
Pointer(s) to the system(s) corresponding to the participting media radiation equation(s)
Definition LinearAssemblySegregatedSolve.h:148
LinearAssemblySegregatedSolve::_active_scalar_petsc_options
Moose::PetscSupport::PetscOptions _active_scalar_petsc_options
Options which hold the petsc settings for the active scalar equation(s)
Definition LinearAssemblySegregatedSolve.h:187
LinearAssemblySegregatedSolve::_pressure_pc_recompute_frequency
const unsigned int _pressure_pc_recompute_frequency
How often (in pressure corrector solves) to recompute the pressure preconditioner.
Definition LinearAssemblySegregatedSolve.h:126
LinearAssemblySegregatedSolve::_active_scalar_equation_relaxation
const std::vector< Real > _active_scalar_equation_relaxation
The user-defined relaxation parameter(s) for the active scalar equation(s)
Definition LinearAssemblySegregatedSolve.h:184
LinearAssemblySegregatedSolve::_active_scalar_systems
std::vector< LinearSystem * > _active_scalar_systems
Pointer(s) to the system(s) corresponding to the active scalar equation(s)
Definition LinearAssemblySegregatedSolve.h:151
LinearAssemblySegregatedSolve::_pressure_pc_solve_counter
unsigned int _pressure_pc_solve_counter
Number of pressure corrector solves performed since the start of the current SIMPLE solve,...
Definition LinearAssemblySegregatedSolve.h:130
LinearAssemblySegregatedSolve::_pressure_system
LinearSystem & _pressure_system
Reference to the linear system corresponding to the pressure equation.
Definition LinearAssemblySegregatedSolve.h:119
LinearAssemblySegregatedSolve::_active_scalar_absolute_tolerance
const std::vector< Real > _active_scalar_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in active scalars.
Definition LinearAssemblySegregatedSolve.h:197
LinearAssemblySegregatedSolve::_has_active_scalar_systems
const bool _has_active_scalar_systems
Boolean for easy check if a active scalar systems shall be solved or not.
Definition LinearAssemblySegregatedSolve.h:178
LinearAssemblySegregatedSolve::_active_scalar_system_names
const std::vector< SolverSystemName > & _active_scalar_system_names
The names of the active scalar systems.
Definition LinearAssemblySegregatedSolve.h:175
LinearAssemblySegregatedSolve::_pressure_sys_number
const unsigned int _pressure_sys_number
The number of the system corresponding to the pressure equation.
Definition LinearAssemblySegregatedSolve.h:116
LinearAssemblySegregatedSolve::_active_scalar_system_numbers
std::vector< unsigned int > _active_scalar_system_numbers
Definition LinearAssemblySegregatedSolve.h:181
LinearAssemblySegregatedSolve::_should_solve_momentum
const bool _should_solve_momentum
Flags controlling which systems are actively solved (can be used with restart to freeze flow)
Definition LinearAssemblySegregatedSolve.h:163
LinearAssemblySegregatedSolve::_passive_scalar_systems
std::vector< LinearSystem * > _passive_scalar_systems
Pointer(s) to the system(s) corresponding to the passive scalar equation(s)
Definition LinearAssemblySegregatedSolve.h:145
SolveObject::parameters
const InputParameters & parameters() const
SolveObject::paramError
void paramError(const std::string &param, Args... args) const
SolveObject::getParam
const T & getParam(const std::string &name) const
MooseMesh::dimension
virtual unsigned int dimension() const
NS::FV::CHTHandler::enabled
virtual bool enabled() const override final
Check if CHT treatment is needed.
Definition CHTHandler.h:152
NS::FV::CHTHandler::linkEnergySystems
void linkEnergySystems(SystemBase *solid_energy_system, SystemBase *fluid_energy_system, std::vector< SystemBase * > pm_radiation_systems)
Link energy systems.
Definition CHTHandler.C:91
SIMPLESolveBase
Solve class serving as a base class for the two SIMPLE solvers that operate with different assembly a...
Definition SIMPLESolveBase.h:42
SIMPLESolveBase::_has_energy_system
const bool _has_energy_system
Boolean for easy check if a fluid energy system shall be solved or not.
Definition SIMPLESolveBase.h:127
SIMPLESolveBase::_pm_radiation_system_numbers
std::vector< unsigned int > _pm_radiation_system_numbers
Definition SIMPLESolveBase.h:190
SIMPLESolveBase::_has_turbulence_systems
const bool _has_turbulence_systems
Boolean for easy check if a turbulence scalar systems shall be solved or not.
Definition SIMPLESolveBase.h:211
SIMPLESolveBase::_turbulence_system_numbers
std::vector< unsigned int > _turbulence_system_numbers
Definition SIMPLESolveBase.h:214
SIMPLESolveBase::_passive_scalar_system_names
const std::vector< SolverSystemName > & _passive_scalar_system_names
The names of the passive scalar systems.
Definition SIMPLESolveBase.h:160
SIMPLESolveBase::_passive_scalar_system_numbers
std::vector< unsigned int > _passive_scalar_system_numbers
Definition SIMPLESolveBase.h:166
SIMPLESolveBase::_has_pm_radiation_systems
const bool _has_pm_radiation_systems
Boolean for easy check if participating media radiation systems shall be solved or not.
Definition SIMPLESolveBase.h:187
SIMPLESolveBase::_turbulence_system_names
const std::vector< SolverSystemName > & _turbulence_system_names
The names of the turbulence systems.
Definition SIMPLESolveBase.h:208
SIMPLESolveBase::_has_solid_energy_system
const bool _has_solid_energy_system
Boolean for easy check if a solid energy system shall be solved or not.
Definition SIMPLESolveBase.h:145
SIMPLESolveBase::_has_passive_scalar_systems
const bool _has_passive_scalar_systems
Boolean for easy check if a passive scalar systems shall be solved or not.
Definition SIMPLESolveBase.h:163
SIMPLESolveBase::_pm_radiation_system_names
const std::vector< SolverSystemName > & _pm_radiation_system_names
The names of the participating media radiation systems.
Definition SIMPLESolveBase.h:184
SIMPLESolveBase::_momentum_system_names
const std::vector< SolverSystemName > & _momentum_system_names
The names of the momentum systems.
Definition SIMPLESolveBase.h:82
SolveObject::_problem
FEProblemBase & _problem
libMesh::SolverConfiguration::int_valued_data
std::map< std::string, int > int_valued_data
libMesh::SolverConfiguration::real_valued_data
std::map< std::string, Real > real_valued_data
Moose::PetscSupport::addPetscFlagsToPetscOptions
void addPetscFlagsToPetscOptions(const MultiMooseEnum &petsc_flags, std::string prefix, const ParallelParamObject &param_object, PetscOptions &petsc_options)
Moose::PetscSupport::addPetscPairsToPetscOptions
void addPetscPairsToPetscOptions(const std::vector< std::pair< MooseEnumItem, std::string > > &petsc_pair_options, const unsigned int mesh_dimension, std::string prefix, const ParallelParamObject &param_object, PetscOptions &petsc_options)
libMesh
The following methods are specializations for using the Parallel::packed_range_* routines for a vecto...
libMesh::index_range
auto index_range(const T &sizable)
libMesh::invalid_uint
const unsigned int invalid_uint
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ checkDependentParameterError()

void SIMPLESolveBase::checkDependentParameterError ( const std::string &  main_parameter,
const std::vector< std::string > &  dependent_parameters,
const bool  should_be_defined 
)
protectedinherited

Definition at line 707 of file SIMPLESolveBase.C.

710{
711 for (const auto & param : dependent_parameters)
712 if (parameters().isParamSetByUser(param) == !should_be_defined)
713 paramError(param,
714 "This parameter should " + std::string(should_be_defined ? "" : "not") +
715 " be given by the user with the corresponding " + main_parameter +
716 " setting!");
717}
SolveObject::isParamSetByUser
bool isParamSetByUser(const std::string &name) const
libMesh::if
if(subdm)

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly().

◆ checkIntegrity()

virtual void SIMPLESolveBase::checkIntegrity ( )
inlinevirtualinherited

Check if the user defined time kernels.

Reimplemented in SIMPLESolve, and SIMPLESolveNonlinearAssembly.

Definition at line 61 of file SIMPLESolveBase.h.

61{}

◆ correctVelocity()

std::pair< unsigned int, Real > LinearAssemblySegregatedSolve::correctVelocity ( const bool  subtract_updated_pressure,
const bool  recompute_face_mass_flux,
const SolverParams &  solver_params 
)
protectedvirtual

Computes new velocity field based on computed pressure gradients.

Parameters
subtract_updated_pressureIf we need to subtract the updated pressure gradient from the right hand side of the system
recompute_face_mass_fluxIf we want to recompute the face flux too
solver_paramsDummy solver parameter object for the linear solve

Reimplemented in PIMPLESolve.

Definition at line 533 of file LinearAssemblySegregatedSolve.C.

536{
537 // Compute the coupling fields between the momentum and pressure equations.
538 // The first argument makes sure the pressure gradient is staged at the first
539 // iteration
540 _rc_uo->computeHbyA(subtract_updated_pressure, _print_fields);
541
542 // We set the preconditioner/controllable parameters for the pressure equations through
543 // petsc options. Linear tolerances will be overridden within the solver.
544 Moose::PetscSupport::petscSetOptions(_pressure_petsc_options, solver_params);
545
546 // Solve the pressure corrector
547 const auto residuals = solvePressureCorrector();
548
549 // Compute the face velocity which is used in the advection terms. In certain
550 // segregated solver algorithms (like PISO) this is only done on the last iteration.
551 if (recompute_face_mass_flux)
552 _rc_uo->computeFaceMassFlux();
553
554 auto & pressure_current_solution = *(_pressure_system.system().current_local_solution.get());
555 auto & pressure_old_solution = *(_pressure_system.solutionPreviousNewton());
556
557 // Relax the pressure update for the next momentum predictor
558 NS::FV::relaxSolutionUpdate(
559 pressure_current_solution, pressure_old_solution, _pressure_variable_relaxation);
560
561 // Overwrite old solution
562 pressure_old_solution = pressure_current_solution;
563 _pressure_system.setSolution(pressure_current_solution);
564
565 // We recompute the updated pressure gradient
566 _pressure_system.computeGradients();
567
568 // Reconstruct the cell velocity as well to accelerate convergence
569 _rc_uo->computeCellVelocity();
570
571 return residuals;
572}
LinearAssemblySegregatedSolve::_rc_uo
RhieChowMassFlux * _rc_uo
Pointer to the segregated RhieChow interpolation object.
Definition LinearAssemblySegregatedSolve.h:157
LinearAssemblySegregatedSolve::solvePressureCorrector
virtual std::pair< unsigned int, Real > solvePressureCorrector() override
Solve a pressure corrector step.
Definition LinearAssemblySegregatedSolve.C:402
LinearSystem::system
virtual System & system() override
LinearSystem::computeGradients
void computeGradients()
RhieChowMassFlux::computeHbyA
void computeHbyA(const bool with_updated_pressure, const bool verbose)
Computes the inverse of the diagonal (1/A) of the system matrix plus the H/A components for the press...
Definition RhieChowMassFlux.C:541
RhieChowMassFlux::computeCellVelocity
void computeCellVelocity()
Update the cell values of the velocity variables.
Definition RhieChowMassFlux.C:396
RhieChowMassFlux::computeFaceMassFlux
void computeFaceMassFlux()
Update the values of the face velocities in the containers.
Definition RhieChowMassFlux.C:326
SIMPLESolveBase::_pressure_variable_relaxation
const Real _pressure_variable_relaxation
The user-defined relaxation parameter for the pressure variable.
Definition SIMPLESolveBase.h:113
SIMPLESolveBase::_pressure_petsc_options
Moose::PetscSupport::PetscOptions _pressure_petsc_options
Options which hold the petsc settings for the pressure equation.
Definition SIMPLESolveBase.h:110
SIMPLESolveBase::_print_fields
const bool _print_fields
Debug parameter which allows printing the coupling and solution vectors/matrices.
Definition SIMPLESolveBase.h:267
LinearSystem::setSolution
void setSolution(const NumericVector< Number > &soln)
LinearSystem::solutionPreviousNewton
virtual const NumericVector< Number > * solutionPreviousNewton() const
libMesh::System::current_local_solution
std::unique_ptr< NumericVector< Number > > current_local_solution
Moose::PetscSupport::petscSetOptions
void petscSetOptions(const PetscOptions &po, const SolverParams &solver_params, FEProblemBase *const problem=nullptr)
NS::FV::relaxSolutionUpdate
void relaxSolutionUpdate(NumericVector< Number > &vec_new, const NumericVector< Number > &vec_old, const Real relaxation_factor)
Relax the update on a solution field using the following approach: $u = u_{old}+\lambda (u - u_{old})...
Definition SegregatedSolverUtils.C:112

Referenced by PIMPLESolve::correctVelocity(), and solve().

◆ initialSetup()

void LinearAssemblySegregatedSolve::initialSetup ( )
overridevirtual

Reimplemented from SolveObject.

Definition at line 392 of file LinearAssemblySegregatedSolve.C.

393{
394 if (_cht.enabled())
395 {
396 _cht.deduceCHTBoundaryCoupling();
397 _cht.setupConjugateHeatTransferContainers();
398 }
399}
NS::FV::CHTHandler::deduceCHTBoundaryCoupling
void deduceCHTBoundaryCoupling()
Run error checks and make sure everything works.
Definition CHTHandler.C:106
NS::FV::CHTHandler::setupConjugateHeatTransferContainers
void setupConjugateHeatTransferContainers()
Set up the boundary condition pairs, functor maps, and every other necessary structure for the conjug...
Definition CHTHandler.C:291

Referenced by PIMPLE::init(), and SIMPLE::init().

◆ linkRhieChowUserObject()

void LinearAssemblySegregatedSolve::linkRhieChowUserObject ( )
overridevirtual

Fetch the Rhie Chow user object that is reponsible for determining face velocities and mass flux.

Implements SIMPLESolveBase.

Definition at line 278 of file LinearAssemblySegregatedSolve.C.

279{
280 if (!_should_solve_momentum)
281 return;
282
283 _rc_uo =
284 const_cast<RhieChowMassFlux *>(&getUserObject<RhieChowMassFlux>("rhie_chow_user_object"));
285 _rc_uo->linkMomentumPressureSystems(
286 _momentum_systems, _pressure_system, _momentum_system_numbers);
287
288 // Initialize the face velocities in the RC object
289 if (!_app.isRecovering())
290 _rc_uo->initFaceMassFlux();
291 _rc_uo->initCouplingField();
292}
MooseApp::isRecovering
bool isRecovering() const
SolveObject::_app
MooseApp & _app
RhieChowMassFlux
User object responsible for determining the face fluxes using the Rhie-Chow interpolation in a segreg...
Definition RhieChowMassFlux.h:37
RhieChowMassFlux::initFaceMassFlux
void initFaceMassFlux()
Initialize the container for face velocities.
Definition RhieChowMassFlux.C:239
RhieChowMassFlux::initCouplingField
void initCouplingField()
Initialize the coupling fields (HbyA and Ainv)
Definition RhieChowMassFlux.C:416
RhieChowMassFlux::linkMomentumPressureSystems
void linkMomentumPressureSystems(const std::vector< LinearSystem * > &momentum_systems, const LinearSystem &pressure_system, const std::vector< unsigned int > &momentum_system_numbers)
Update the momentum system-related information.
Definition RhieChowMassFlux.C:122

Referenced by PIMPLE::init(), and SIMPLE::init().

◆ setInnerSolve()

virtual void SIMPLESolveBase::setInnerSolve ( SolveObject &  )
inlineoverridevirtualinherited

Reimplemented from SolveObject.

Definition at line 48 of file SIMPLESolveBase.h.

49 {
50 mooseError("Cannot set inner solve object for solves that inherit from SIMPLESolveBase");
51 }
SolveObject::mooseError
void mooseError(Args &&... args) const

◆ setupPressurePin()

void SIMPLESolveBase::setupPressurePin ( )
inherited

Setup pressure pin if there is need for one.

Definition at line 698 of file SIMPLESolveBase.C.

699{
700 if (_pin_pressure)
701 _pressure_pin_dof = NS::FV::findPointDoFID(_problem.getVariable(0, "pressure"),
702 _problem.mesh(),
703 getParam<Point>("pressure_pin_point"));
704}
FEProblemBase::getVariable
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const override
SIMPLESolveBase::_pressure_pin_dof
dof_id_type _pressure_pin_dof
The dof ID where the pressure needs to be pinned.
Definition SIMPLESolveBase.h:122
SIMPLESolveBase::_pin_pressure
const bool _pin_pressure
If the pressure needs to be pinned.
Definition SIMPLESolveBase.h:116
NS::FV::findPointDoFID
dof_id_type findPointDoFID(const MooseVariableFieldBase &variable, const MooseMesh &mesh, const Point &point)
Find the ID of the degree of freedom which corresponds to the variable and a given point on the mesh.
Definition SegregatedSolverUtils.C:197

Referenced by PIMPLE::init(), SIMPLE::init(), and SIMPLENonlinearAssembly::init().

◆ setupResidualStorage()

LinearAssemblySegregatedSolve::ResidualStorage LinearAssemblySegregatedSolve::setupResidualStorage ( ) const
protected

Build residual/tolerance vectors and associated indices for all enabled systems.

Definition at line 888 of file LinearAssemblySegregatedSolve.C.

889{
890 ResidualStorage storage;
891
892 // Residual store: position in this vector defines the ordering used by NS::FV::converged()
893 // Each entry holds (linear its, normalized residual) for one system
894 if (_should_solve_momentum)
895 for ([[maybe_unused]] const auto system_i : index_range(_momentum_systems))
896 {
897 storage.momentum_indices.push_back(storage.ns_residuals.size());
898 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
899 storage.ns_abs_tols.push_back(_momentum_absolute_tolerance);
900 }
901
902 if (_should_solve_pressure)
903 {
904 storage.pressure_index = storage.ns_residuals.size();
905 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
906 storage.ns_abs_tols.push_back(_pressure_absolute_tolerance);
907 }
908
909 if (_has_energy_system && _should_solve_energy)
910 {
911 storage.energy_index = storage.ns_residuals.size();
912 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
913 storage.ns_abs_tols.push_back(_energy_absolute_tolerance);
914 }
915
916 if (_has_solid_energy_system && _should_solve_solid_energy)
917 {
918 storage.solid_energy_index = storage.ns_residuals.size();
919 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
920 storage.ns_abs_tols.push_back(_solid_energy_absolute_tolerance);
921 }
922
923 if (_has_active_scalar_systems && _should_solve_active_scalars)
924 for (const auto i : index_range(_active_scalar_system_names))
925 {
926 storage.active_scalar_indices.push_back(storage.ns_residuals.size());
927 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
928 storage.ns_abs_tols.push_back(_active_scalar_absolute_tolerance[i]);
929 }
930
931 if (_has_turbulence_systems && _should_solve_turbulence)
932 for (const auto i : index_range(_turbulence_system_names))
933 {
934 storage.turbulence_indices.push_back(storage.ns_residuals.size());
935 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
936 storage.ns_abs_tols.push_back(_turbulence_absolute_tolerance[i]);
937 }
938
939 if (_has_pm_radiation_systems && _should_solve_pm_radiation)
940 for (const auto i : index_range(_pm_radiation_system_names))
941 {
942 storage.pm_radiation_indices.push_back(storage.ns_residuals.size());
943 storage.ns_residuals.push_back(std::make_pair(0, 1.0));
944 storage.ns_abs_tols.push_back(_pm_radiation_absolute_tolerance[i]);
945 }
946
947 storage.converged = storage.ns_residuals.empty();
948 return storage;
949}
SIMPLESolveBase::_pm_radiation_absolute_tolerance
const std::vector< Real > _pm_radiation_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in participating media radiation.
Definition SIMPLESolveBase.h:253
SIMPLESolveBase::_pressure_absolute_tolerance
const Real _pressure_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in pressure.
Definition SIMPLESolveBase.h:241
SIMPLESolveBase::_turbulence_absolute_tolerance
const std::vector< Real > _turbulence_absolute_tolerance
The user-defined absolute tolerance for determining the convergence turbulence variables.
Definition SIMPLESolveBase.h:256
SIMPLESolveBase::_momentum_absolute_tolerance
const Real _momentum_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in momentum.
Definition SIMPLESolveBase.h:238
SIMPLESolveBase::_energy_absolute_tolerance
const Real _energy_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in energy.
Definition SIMPLESolveBase.h:244
SIMPLESolveBase::_solid_energy_absolute_tolerance
const Real _solid_energy_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in solid energy.
Definition SIMPLESolveBase.h:247

Referenced by solve().

◆ solve()

bool LinearAssemblySegregatedSolve::solve ( )
overridevirtual

Performs the momentum pressure coupling.

Returns
True if solver is converged.

Implements SolveObject.

Definition at line 662 of file LinearAssemblySegregatedSolve.C.

663{
664 // Do not solve if problem is set not to
665 if (!_problem.shouldSolve())
666 return true;
667
668 Moose::PetscSupport::PetscOptionsScope petsc_options_scope(_problem);
669
670 // Dummy solver parameter file which is needed for switching petsc options
671 SolverParams solver_params;
672 solver_params._type = Moose::SolveType::ST_LINEAR;
673 solver_params._line_search = Moose::LineSearchType::LS_NONE;
674
675 // Initialize the SIMPLE iteration counter
676 unsigned int simple_iteration_counter = 0;
677
678 // Rebuild the pressure preconditioner on the first solve of this (e.g. time) step before reusing
679 // it according to _pressure_pc_recompute_frequency.
680 _pressure_pc_solve_counter = 0;
681
682 // We set up the residual storage and the corresponding tolerances.
683 ResidualStorage residual_storage = setupResidualStorage();
684 auto & ns_residuals = residual_storage.ns_residuals;
685 auto & ns_abs_tols = residual_storage.ns_abs_tols;
686 const auto & momentum_indices = residual_storage.momentum_indices;
687 const auto pressure_index = residual_storage.pressure_index;
688 const auto energy_index = residual_storage.energy_index;
689 const auto solid_energy_index = residual_storage.solid_energy_index;
690 const auto & active_scalar_indices = residual_storage.active_scalar_indices;
691 const auto & turbulence_indices = residual_storage.turbulence_indices;
692 const auto & pm_radiation_indices = residual_storage.pm_radiation_indices;
693
694 bool converged = residual_storage.converged;
695
696 // Loop until converged or hit the maximum allowed iteration number
697 if (_cht.enabled() && _should_solve_energy)
698 _cht.initializeCHTCouplingFields();
699
700 while (simple_iteration_counter < _num_iterations && !converged)
701 {
702 simple_iteration_counter++;
703
704 // We set the preconditioner/controllable parameters through petsc options. Linear
705 // tolerances will be overridden within the solver. In case of a segregated momentum
706 // solver, we assume that every velocity component uses the same preconditioner
707 if (_should_solve_momentum)
708 Moose::PetscSupport::petscSetOptions(_momentum_petsc_options, solver_params);
709
710 // Initialize pressure gradients, after this we just reuse the last ones from each
711 // iteration
712 if (_should_solve_pressure && simple_iteration_counter == 1)
713 _pressure_system.computeGradients();
714
715 _console << "Iteration " << simple_iteration_counter << " Initial residual norms:" << std::endl;
716
717 // Solve the momentum predictor step
718 if (_should_solve_momentum)
719 {
720 auto momentum_residual = solveMomentumPredictor();
721 for (const auto system_i : index_range(momentum_residual))
722 ns_residuals[momentum_indices[system_i]] = momentum_residual[system_i];
723 }
724
725 // Now we correct the velocity, this function depends on the method, it differs for
726 // SIMPLE/PIMPLE, this returns the pressure errors
727 if (_should_solve_pressure)
728 ns_residuals[pressure_index] = correctVelocity(true, true, solver_params);
729
730 // If we have an energy equation, solve it here.We assume the material properties in the
731 // Navier-Stokes equations depend on temperature, therefore we can not solve for temperature
732 // outside of the velocity-pressure loop
733 if (_has_energy_system && _should_solve_energy)
734 {
735 // If there is no CHT specified this will just do go once through this block
736 _cht.resetCHTConvergence();
737 while (!_cht.converged())
738 {
739 if (_cht.enabled())
740 _cht.updateCHTBoundaryCouplingFields(NS::CHTSide::FLUID);
741
742 // We set the preconditioner/controllable parameters through petsc options. Linear
743 // tolerances will be overridden within the solver.
744 Moose::PetscSupport::petscSetOptions(_energy_petsc_options, solver_params);
745 ns_residuals[energy_index] = solveAdvectedSystem(_energy_sys_number,
746 *_energy_system,
747 _energy_equation_relaxation,
748 _energy_linear_control,
749 _energy_l_abs_tol);
750
751 if (_has_pm_radiation_systems && _should_solve_pm_radiation)
752 {
753 // We set the preconditioner/controllable parameters through petsc options. Linear
754 // tolerances will be overridden within the solver.
755 Moose::PetscSupport::petscSetOptions(_pm_radiation_petsc_options, solver_params);
756 for (const auto i : index_range(_pm_radiation_system_names))
757 {
758 ns_residuals[pm_radiation_indices[i]] =
759 solveAdvectedSystem(_pm_radiation_system_numbers[i],
760 *_pm_radiation_systems[i],
761 _pm_radiation_equation_relaxation[i],
762 _pm_radiation_linear_control,
763 _pm_radiation_l_abs_tol);
764 }
765 }
766
767 if (_has_solid_energy_system && _should_solve_solid_energy)
768 {
769 // For now we only update gradients if cht is needed, might change in the future
770 if (_cht.enabled())
771 {
772 _energy_system->computeGradients();
773 _cht.updateCHTBoundaryCouplingFields(NS::CHTSide::SOLID);
774 }
775
776 // We set the preconditioner/controllable parameters through petsc options. Linear
777 // tolerances will be overridden within the solver.
778 Moose::PetscSupport::petscSetOptions(_solid_energy_petsc_options, solver_params);
779 ns_residuals[solid_energy_index] = solveSolidEnergy();
780
781 // For now we only update gradients if cht is needed, might change in the future
782 if (_cht.enabled())
783 _solid_energy_system->computeGradients();
784 }
785
786 if (_cht.enabled())
787 {
788 _cht.sumIntegratedFluxes();
789 _cht.printIntegratedFluxes();
790 }
791
792 _cht.incrementCHTIterators();
793 }
794 if (_cht.enabled())
795 _cht.resetIntegratedFluxes();
796 }
797
798 // If we have active scalar equations, solve them here in case they depend on temperature
799 // or they affect the fluid properties such that they must be solved concurrently with
800 // pressure and velocity
801 if (_has_active_scalar_systems && _should_solve_active_scalars)
802 {
803 _problem.execute(EXEC_NONLINEAR);
804
805 // We set the preconditioner/controllable parameters through petsc options. Linear
806 // tolerances will be overridden within the solver.
807 Moose::PetscSupport::petscSetOptions(_active_scalar_petsc_options, solver_params);
808 for (const auto i : index_range(_active_scalar_system_names))
809 ns_residuals[active_scalar_indices[i]] =
810 solveAdvectedSystem(_active_scalar_system_numbers[i],
811 *_active_scalar_systems[i],
812 _active_scalar_equation_relaxation[i],
813 _active_scalar_linear_control,
814 _active_scalar_l_abs_tol);
815 }
816
817 // If we have turbulence equations, solve them here.
818 // The turbulent viscosity depends on the value of the turbulence surrogate variables
819 if (_has_turbulence_systems && _should_solve_turbulence)
820 {
821 // We set the preconditioner/controllable parameters through petsc options. Linear
822 // tolerances will be overridden within the solver.
823 Moose::PetscSupport::petscSetOptions(_turbulence_petsc_options, solver_params);
824 for (const auto i : index_range(_turbulence_system_names))
825 {
826 ns_residuals[turbulence_indices[i]] =
827 solveAdvectedSystem(_turbulence_system_numbers[i],
828 *_turbulence_systems[i],
829 _turbulence_equation_relaxation[i],
830 _turbulence_linear_control,
831 _turbulence_l_abs_tol,
832 _turbulence_field_relaxation[i],
833 _turbulence_field_min_limit[i]);
834 }
835 }
836
837 _problem.execute(EXEC_NONLINEAR);
838
839 converged = NS::FV::converged(ns_residuals, ns_abs_tols);
840 }
841
842 // If we have passive scalar equations, solve them here. We assume the material properties in
843 // the Navier-Stokes equations do not depend on passive scalars, as they are passive, therefore
844 // we solve outside of the velocity-pressure loop
845 if (_has_passive_scalar_systems && _should_solve_passive_scalars &&
846 (converged || _continue_on_max_its))
847 {
848 // The reason why we need more than one iteration is due to the matrix relaxation
849 // which can be used to stabilize the equations
850 bool passive_scalar_converged = false;
851 unsigned int ps_iteration_counter = 0;
852
853 _console << "Passive scalar iteration " << ps_iteration_counter
854 << " Initial residual norms:" << std::endl;
855
856 while (ps_iteration_counter < _num_iterations && !passive_scalar_converged)
857 {
858 ps_iteration_counter++;
859 std::vector<std::pair<unsigned int, Real>> scalar_residuals(
860 _passive_scalar_system_names.size(), std::make_pair(0, 1.0));
861 std::vector<Real> scalar_abs_tols;
862 for (const auto scalar_tol : _passive_scalar_absolute_tolerance)
863 scalar_abs_tols.push_back(scalar_tol);
864
865 // We set the preconditioner/controllable parameters through petsc options. Linear
866 // tolerances will be overridden within the solver.
867 Moose::PetscSupport::petscSetOptions(_passive_scalar_petsc_options, solver_params);
868 for (const auto i : index_range(_passive_scalar_system_names))
869 scalar_residuals[i] = solveAdvectedSystem(_passive_scalar_system_numbers[i],
870 *_passive_scalar_systems[i],
871 _passive_scalar_equation_relaxation[i],
872 _passive_scalar_linear_control,
873 _passive_scalar_l_abs_tol);
874
875 passive_scalar_converged = NS::FV::converged(scalar_residuals, scalar_abs_tols);
876 }
877
878 // Both flow and scalars must converge
879 converged = passive_scalar_converged && converged;
880 }
881
882 converged = _continue_on_max_its ? true : converged;
883
884 return converged;
885}
SolveObject::_console
const ConsoleStream _console
FEProblemBase::shouldSolve
bool shouldSolve() const
FEProblemBase::execute
virtual void execute(const ExecFlagType &exec_type)
LinearAssemblySegregatedSolve::solveSolidEnergy
std::pair< unsigned int, Real > solveSolidEnergy()
Solve an equation which contains the solid energy conservation.
Definition LinearAssemblySegregatedSolve.C:473
LinearAssemblySegregatedSolve::correctVelocity
virtual std::pair< unsigned int, Real > correctVelocity(const bool subtract_updated_pressure, const bool recompute_face_mass_flux, const SolverParams &solver_params)
Computes new velocity field based on computed pressure gradients.
Definition LinearAssemblySegregatedSolve.C:533
LinearAssemblySegregatedSolve::setupResidualStorage
ResidualStorage setupResidualStorage() const
Build residual/tolerance vectors and associated indices for all enabled systems.
Definition LinearAssemblySegregatedSolve.C:888
LinearAssemblySegregatedSolve::solveAdvectedSystem
std::pair< unsigned int, Real > solveAdvectedSystem(const unsigned int system_num, LinearSystem &system, const Real relaxation_factor, libMesh::SolverConfiguration &solver_config, const Real abs_tol, const Real field_relaxation=1.0, const Real min_value_limiter=std::numeric_limits< Real >::min())
Solve an equation which contains an advection term that depends on the solution of the segregated Nav...
Definition LinearAssemblySegregatedSolve.C:575
LinearAssemblySegregatedSolve::solveMomentumPredictor
virtual std::vector< std::pair< unsigned int, Real > > solveMomentumPredictor() override
Solve a momentum predictor step with a fixed pressure field.
Definition LinearAssemblySegregatedSolve.C:295
NS::FV::CHTHandler::sumIntegratedFluxes
void sumIntegratedFluxes()
Sum the integrated fluxes over all processors.
Definition CHTHandler.C:465
NS::FV::CHTHandler::printIntegratedFluxes
void printIntegratedFluxes() const
Print the integrated heat fluxes.
Definition CHTHandler.C:476
NS::FV::CHTHandler::resetCHTConvergence
void resetCHTConvergence()
Reset the convergence data.
Definition CHTHandler.h:158
NS::FV::CHTHandler::resetIntegratedFluxes
void resetIntegratedFluxes()
Reset the heat fluxes to 0.
Definition CHTHandler.C:488
NS::FV::CHTHandler::initializeCHTCouplingFields
void initializeCHTCouplingFields()
Initialize the coupling fields for the conjugate heat transfer routines.
Definition CHTHandler.C:371
NS::FV::CHTHandler::converged
bool converged() const
Check if CHT iteration converged.
Definition CHTHandler.C:495
NS::FV::CHTHandler::updateCHTBoundaryCouplingFields
void updateCHTBoundaryCouplingFields(const NS::CHTSide side)
Update the coupling fields for.
Definition CHTHandler.C:392
NS::FV::CHTHandler::incrementCHTIterators
void incrementCHTIterators()
Increment CHT iterators in the loop.
Definition CHTHandler.h:164
SIMPLESolveBase::_turbulence_equation_relaxation
const std::vector< Real > _turbulence_equation_relaxation
The user-defined relaxation parameter(s) for the turbulence equation(s)
Definition SIMPLESolveBase.h:217
SIMPLESolveBase::_pm_radiation_linear_control
SIMPLESolverConfiguration _pm_radiation_linear_control
Options for the linear solver of the participating media radiation equation(s)
Definition SIMPLESolveBase.h:199
SIMPLESolveBase::_turbulence_petsc_options
Moose::PetscSupport::PetscOptions _turbulence_petsc_options
Options which hold the petsc settings for the turbulence equation(s)
Definition SIMPLESolveBase.h:226
SIMPLESolveBase::_turbulence_l_abs_tol
const Real _turbulence_l_abs_tol
Absolute linear tolerance for the turbulence equation(s).
Definition SIMPLESolveBase.h:233
SIMPLESolveBase::_passive_scalar_equation_relaxation
const std::vector< Real > _passive_scalar_equation_relaxation
The user-defined relaxation parameter(s) for the passive scalar equation(s)
Definition SIMPLESolveBase.h:169
SIMPLESolveBase::_passive_scalar_l_abs_tol
const Real _passive_scalar_l_abs_tol
Absolute linear tolerance for the passive scalar equation(s).
Definition SIMPLESolveBase.h:179
SIMPLESolveBase::_passive_scalar_petsc_options
Moose::PetscSupport::PetscOptions _passive_scalar_petsc_options
Options which hold the petsc settings for the passive scalar equation(s)
Definition SIMPLESolveBase.h:172
SIMPLESolveBase::_turbulence_field_relaxation
std::vector< Real > _turbulence_field_relaxation
The user-defined relaxation parameter(s) for the turbulence field(s)
Definition SIMPLESolveBase.h:220
SIMPLESolveBase::_turbulence_field_min_limit
std::vector< Real > _turbulence_field_min_limit
The user-defined lower limit for turbulent quantities e.g. k, eps/omega, etc..
Definition SIMPLESolveBase.h:223
SIMPLESolveBase::_pm_radiation_petsc_options
Moose::PetscSupport::PetscOptions _pm_radiation_petsc_options
Options which hold the petsc settings for the participating media radiation equation(s)
Definition SIMPLESolveBase.h:196
SIMPLESolveBase::_pm_radiation_l_abs_tol
const Real _pm_radiation_l_abs_tol
Absolute linear tolerance for the participating media radiation equation(s).
Definition SIMPLESolveBase.h:203
SIMPLESolveBase::_momentum_petsc_options
Moose::PetscSupport::PetscOptions _momentum_petsc_options
Options which hold the petsc settings for the momentum equation.
Definition SIMPLESolveBase.h:92
SIMPLESolveBase::_energy_linear_control
SIMPLESolverConfiguration _energy_linear_control
Options for the linear solver of the energy equation.
Definition SIMPLESolveBase.h:136
SIMPLESolveBase::_energy_l_abs_tol
const Real _energy_l_abs_tol
Absolute linear tolerance for the energy equations.
Definition SIMPLESolveBase.h:140
SIMPLESolveBase::_solid_energy_petsc_options
Moose::PetscSupport::PetscOptions _solid_energy_petsc_options
Options which hold the petsc settings for the fluid energy equation.
Definition SIMPLESolveBase.h:148
SIMPLESolveBase::_continue_on_max_its
const bool _continue_on_max_its
If solve should continue if maximum number of iterations is hit.
Definition SIMPLESolveBase.h:262
SIMPLESolveBase::_num_iterations
const unsigned int _num_iterations
The maximum number of momentum-pressure iterations.
Definition SIMPLESolveBase.h:259
SIMPLESolveBase::_passive_scalar_absolute_tolerance
const std::vector< Real > _passive_scalar_absolute_tolerance
The user-defined absolute tolerance for determining the convergence in passive scalars.
Definition SIMPLESolveBase.h:250
SIMPLESolveBase::_turbulence_linear_control
SIMPLESolverConfiguration _turbulence_linear_control
Options for the linear solver of the turbulence equation(s)
Definition SIMPLESolveBase.h:229
SIMPLESolveBase::_energy_equation_relaxation
const Real _energy_equation_relaxation
The user-defined relaxation parameter for the energy equation.
Definition SIMPLESolveBase.h:130
SIMPLESolveBase::_passive_scalar_linear_control
SIMPLESolverConfiguration _passive_scalar_linear_control
Options for the linear solver of the passive scalar equation(s)
Definition SIMPLESolveBase.h:175
SIMPLESolveBase::_energy_petsc_options
Moose::PetscSupport::PetscOptions _energy_petsc_options
Options which hold the petsc settings for the fluid energy equation.
Definition SIMPLESolveBase.h:133
SIMPLESolveBase::_pm_radiation_equation_relaxation
const std::vector< Real > _pm_radiation_equation_relaxation
The user-defined relaxation parameter(s) for the participating media radiation equation(s)
Definition SIMPLESolveBase.h:193
SolverParams::_line_search
Moose::LineSearchType _line_search
SolverParams::_type
Moose::SolveType _type
NS::FV::converged
bool converged(const std::vector< std::pair< unsigned int, Real > > &residuals, const std::vector< Real > &abs_tolerances)
Based on the residuals, determine if the iterative process converged or not.
Definition SegregatedSolverUtils.C:229
NS::SOLID
@ SOLID
Definition NS.h:200
NS::FLUID
@ FLUID
Definition NS.h:201

◆ solveAdvectedSystem()

std::pair< unsigned int, Real > LinearAssemblySegregatedSolve::solveAdvectedSystem ( const unsigned int  system_num,
LinearSystem &  system,
const Real  relaxation_factor,
libMesh::SolverConfiguration &  solver_config,
const Real  abs_tol,
const Real  field_relaxation = 1.0,
const Real  min_value_limiter = std::numeric_limits<Real>::min() 
)
protected

Solve an equation which contains an advection term that depends on the solution of the segregated Navier-Stokes equations.

Parameters
system_numThe number of the system which is solved
systemReference to the system which is solved
relaxation_factorThe relaxation factor for matrix relaxation
solver_configThe solver configuration object for the linear solve
abs_tolThe scaled absolute tolerance for the linear solve
field_relaxation(optional) The relaxation factor for fields if relax_fields is true. Default value is 1.0.
min_value_limiter(optional) The minimum value for the solution field
Returns
The normalized residual norm of the equation.

Definition at line 575 of file LinearAssemblySegregatedSolve.C.

582{
583 _problem.setCurrentLinearSystem(system_num);
584
585 // We will need some members from the implicit linear system
586 LinearImplicitSystem & li_system = libMesh::cast_ref<LinearImplicitSystem &>(system.system());
587
588 // We will need the solution, the right hand side and the matrix
589 NumericVector<Number> & current_local_solution = *(li_system.current_local_solution);
590 NumericVector<Number> & solution = *(li_system.solution);
591 SparseMatrix<Number> & mmat = *(li_system.matrix);
592 NumericVector<Number> & rhs = *(li_system.rhs);
593
594 // We need a vector that stores the (diagonal_relaxed-original_diagonal) vector
595 auto diff_diagonal = solution.zero_clone();
596
597 // Fetch the linear solver from the system
598 PetscLinearSolver<Real> & linear_solver =
599 libMesh::cast_ref<PetscLinearSolver<Real> &>(*li_system.get_linear_solver());
600
601 _problem.computeLinearSystemSys(li_system, mmat, rhs, true);
602
603 // Go and relax the system matrix and the right hand side
604 NS::FV::relaxMatrix(mmat, relaxation_factor, *diff_diagonal);
605 NS::FV::relaxRightHandSide(rhs, solution, *diff_diagonal);
606
607 if (_print_fields)
608 {
609 _console << system.name() << " system matrix" << std::endl;
610 mmat.print();
611 }
612
613 // We compute the normalization factors based on the fluxes
614 Real norm_factor = NS::FV::computeNormalizationFactor(solution, mmat, rhs);
615
616 // We need the non-preconditioned norm to be consistent with the norm factor
617 LibmeshPetscCall(KSPSetNormType(linear_solver.ksp(), KSP_NORM_UNPRECONDITIONED));
618
619 // Setting the linear tolerances and maximum iteration counts
620 solver_config.real_valued_data["abs_tol"] = absolute_tol * norm_factor;
621 linear_solver.set_solver_configuration(solver_config);
622
623 // Solve the system and update current local solution
624 auto its_res_pair = linear_solver.solve(mmat, mmat, solution, rhs);
625 li_system.update();
626
627 if (_print_fields)
628 {
629 _console << " rhs when we solve " << system.name() << std::endl;
630 rhs.print();
631 _console << system.name() << " solution " << std::endl;
632 solution.print();
633 _console << " Norm factor " << norm_factor << std::endl;
634 }
635
636 // Limiting scalar solution
637 if (min_value_limiter != std::numeric_limits<Real>::min())
638 NS::FV::limitSolutionUpdate(current_local_solution, min_value_limiter);
639
640 // Relax the field update for the next momentum predictor
641 if (field_relaxation != 1.0)
642 {
643 auto & old_local_solution = *(system.solutionPreviousNewton());
644 NS::FV::relaxSolutionUpdate(current_local_solution, old_local_solution, field_relaxation);
645
646 // Update old solution, only needed if relaxing the field
647 old_local_solution = current_local_solution;
648 }
649
650 system.setSolution(current_local_solution);
651
652 const auto residuals =
653 std::make_pair(its_res_pair.first, linear_solver.get_initial_residual() / norm_factor);
654
655 _console << " Advected system: " << system.name() << " " << COLOR_GREEN << residuals.second
656 << COLOR_DEFAULT << " Linear its: " << residuals.first << std::endl;
657
658 return residuals;
659}
FEProblemBase::computeLinearSystemSys
virtual void computeLinearSystemSys(libMesh::LinearImplicitSystem &sys, libMesh::SparseMatrix< libMesh::Number > &system_matrix, NumericVector< libMesh::Number > &rhs, const bool compute_gradients=true)
FEProblemBase::setCurrentLinearSystem
void setCurrentLinearSystem(unsigned int sys_num)
LinearSystem::name
virtual const std::string & name() const
libMesh::LinearImplicitSystem::rhs
NumericVector< Number > * rhs
libMesh::LinearImplicitSystem::matrix
SparseMatrix< Number > * matrix
libMesh::LinearImplicitSystem::get_linear_solver
virtual LinearSolver< Number > * get_linear_solver() const override
libMesh::PetscLinearSolver::set_solver_configuration
void set_solver_configuration(SolverConfiguration &solver_configuration)
libMesh::NumericVector::print
virtual void print(std::ostream &os=libMesh::out) const
libMesh::NumericVector::zero_clone
virtual std::unique_ptr< NumericVector< T > > zero_clone() const=0
libMesh::PetscLinearSolver::solve
virtual std::pair< unsigned int, Real > solve(SparseMatrix< T > &matrix_in, NumericVector< T > &solution_in, NumericVector< T > &rhs_in, const std::optional< double > tol=std::nullopt, const std::optional< unsigned int > m_its=std::nullopt) override
libMesh::SparseMatrix::print
void print(std::ostream &os=libMesh::out, const bool sparse=false) const
libMesh::LinearImplicitSystem::solution
std::unique_ptr< NumericVector< Number > > solution
NS::FV::computeNormalizationFactor
Real computeNormalizationFactor(const NumericVector< Number > &solution, const SparseMatrix< Number > &mat, const NumericVector< Number > &rhs)
Compute a normalization factor which is applied to the linear residual to determine convergence.
Definition SegregatedSolverUtils.C:135
NS::FV::relaxMatrix
void relaxMatrix(SparseMatrix< Number > &matrix_in, const Real relaxation_parameter, NumericVector< Number > &diff_diagonal)
Relax the matrix to ensure diagonal dominance, we hold onto the difference in diagonals for later use...
Definition SegregatedSolverUtils.C:25
NS::FV::limitSolutionUpdate
void limitSolutionUpdate(NumericVector< Number > &solution, const Real min_limit=std::numeric_limits< Real >::epsilon(), const Real max_limit=1e10)
Limit a solution to its minimum and maximum bounds: $u = min(max(u, min_limit), max_limit)$.
Definition SegregatedSolverUtils.C:123
NS::FV::relaxRightHandSide
void relaxRightHandSide(NumericVector< Number > &rhs_in, const NumericVector< Number > &solution_in, const NumericVector< Number > &diff_diagonal)
Relax the right hand side of an equation, this needs to be called once and the system matrix has been...
Definition SegregatedSolverUtils.C:91

Referenced by solve().

◆ solveMomentumPredictor()

std::vector< std::pair< unsigned int, Real > > LinearAssemblySegregatedSolve::solveMomentumPredictor ( )
overrideprotectedvirtual

Solve a momentum predictor step with a fixed pressure field.

Returns
A vector of (number of linear iterations, normalized residual norm) pairs for the momentum equations. The length of the vector equals the dimensionality of the domain.

Implements SIMPLESolveBase.

Definition at line 295 of file LinearAssemblySegregatedSolve.C.

296{
297 // Temporary storage for the (flux-normalized) residuals from
298 // different momentum components
299 std::vector<std::pair<unsigned int, Real>> its_normalized_residuals;
300
301 LinearImplicitSystem & momentum_system_0 =
302 libMesh::cast_ref<LinearImplicitSystem &>(_momentum_systems[0]->system());
303
304 PetscLinearSolver<Real> & momentum_solver =
305 libMesh::cast_ref<PetscLinearSolver<Real> &>(*momentum_system_0.get_linear_solver());
306
307 // Solve the momentum equations.
308 // TO DO: These equations are VERY similar. If we can store the differences (things coming from
309 // BCs for example) separately, it is enough to construct one matrix.
310 for (const auto system_i : index_range(_momentum_systems))
311 {
312 _problem.setCurrentLinearSystem(_momentum_system_numbers[system_i]);
313
314 // We will need the right hand side and the solution of the next component
315 LinearImplicitSystem & momentum_system =
316 libMesh::cast_ref<LinearImplicitSystem &>(_momentum_systems[system_i]->system());
317
318 NumericVector<Number> & solution = *(momentum_system.solution);
319 NumericVector<Number> & rhs = *(momentum_system.rhs);
320 SparseMatrix<Number> & mmat = *(momentum_system.matrix);
321
322 auto diff_diagonal = solution.zero_clone();
323
324 // We assemble the matrix and the right hand side
325 _problem.computeLinearSystemSys(momentum_system, mmat, rhs, /*compute_grads*/ true);
326
327 // Still need to relax the right hand side with the same vector
328 NS::FV::relaxMatrix(mmat, _momentum_equation_relaxation, *diff_diagonal);
329 NS::FV::relaxRightHandSide(rhs, solution, *diff_diagonal);
330
331 // The normalization factor depends on the right hand side so we need to recompute it for this
332 // component
333 Real norm_factor = NS::FV::computeNormalizationFactor(solution, mmat, rhs);
334
335 // Very important, for deciding the convergence, we need the unpreconditioned
336 // norms in the linear solve
337 LibmeshPetscCall(KSPSetNormType(momentum_solver.ksp(), KSP_NORM_UNPRECONDITIONED));
338 // Solve this component. We don't update the ghosted solution yet, that will come at the end
339 // of the corrector step. Also setting the linear tolerances and maximum iteration counts.
340 _momentum_linear_control.real_valued_data["abs_tol"] = _momentum_l_abs_tol * norm_factor;
341 momentum_solver.set_solver_configuration(_momentum_linear_control);
342
343 // We solve the equation
344 auto its_resid_pair = momentum_solver.solve(mmat, mmat, solution, rhs);
345 momentum_system.update();
346
347 // We will reuse the preconditioner for every momentum system
348 if (system_i == 0)
349 momentum_solver.reuse_preconditioner(true);
350
351 // Save the normalized residual
352 its_normalized_residuals.push_back(
353 std::make_pair(its_resid_pair.first, momentum_solver.get_initial_residual() / norm_factor));
354
355 if (_print_fields)
356 {
357 _console << " matrix when we solve " << std::endl;
358 mmat.print();
359 _console << " rhs when we solve " << std::endl;
360 rhs.print();
361 _console << " velocity solution component " << system_i << std::endl;
362 solution.print();
363 _console << "Norm factor " << norm_factor << std::endl;
364 _console << Moose::stringify(momentum_solver.get_initial_residual()) << std::endl;
365 }
366
367 // Printing residuals
368 _console << " Momentum equation:"
369 << (_momentum_systems.size() > 1
370 ? std::string(" Component ") + std::to_string(system_i + 1) + std::string(" ")
371 : std::string(" "))
372 << COLOR_GREEN << its_normalized_residuals[system_i].second << COLOR_DEFAULT
373 << " Linear its: " << its_normalized_residuals[system_i].first << std::endl;
374 }
375
376 for (const auto system_i : index_range(_momentum_systems))
377 {
378 LinearImplicitSystem & momentum_system =
379 libMesh::cast_ref<LinearImplicitSystem &>(_momentum_systems[system_i]->system());
380 _momentum_systems[system_i]->setSolution(*(momentum_system.current_local_solution));
381 _momentum_systems[system_i]->copyPreviousSolutions(Moose::SolutionIterationType::Nonlinear);
382 }
383
384 // We reset this to ensure the preconditioner is recomputed new time we go to the momentum
385 // predictor
386 momentum_solver.reuse_preconditioner(false);
387
388 return its_normalized_residuals;
389}
SIMPLESolveBase::_momentum_equation_relaxation
const Real _momentum_equation_relaxation
The user-defined relaxation parameter for the momentum equation.
Definition SIMPLESolveBase.h:95
SIMPLESolveBase::_momentum_l_abs_tol
const Real _momentum_l_abs_tol
Absolute linear tolerance for the momentum equation(s).
Definition SIMPLESolveBase.h:89
SIMPLESolveBase::_momentum_linear_control
SIMPLESolverConfiguration _momentum_linear_control
Options for the linear solver of the momentum equation.
Definition SIMPLESolveBase.h:85
libMesh::PetscLinearSolver::reuse_preconditioner
virtual void reuse_preconditioner(bool)
Moose::stringify
std::string stringify(const T &t)

Referenced by solve().

◆ solvePressureCorrector()

std::pair< unsigned int, Real > LinearAssemblySegregatedSolve::solvePressureCorrector ( )
overrideprotectedvirtual

Solve a pressure corrector step.

Returns
The number of linear iterations and the normalized residual norm of the pressure equation.

Implements SIMPLESolveBase.

Definition at line 402 of file LinearAssemblySegregatedSolve.C.

403{
404 _problem.setCurrentLinearSystem(_pressure_sys_number);
405
406 // We will need some members from the linear system
407 LinearImplicitSystem & pressure_system =
408 libMesh::cast_ref<LinearImplicitSystem &>(_pressure_system.system());
409
410 // We will need the solution, the right hand side and the matrix
411 NumericVector<Number> & current_local_solution = *(pressure_system.current_local_solution);
412 NumericVector<Number> & solution = *(pressure_system.solution);
413 SparseMatrix<Number> & mmat = *(pressure_system.matrix);
414 NumericVector<Number> & rhs = *(pressure_system.rhs);
415
416 // Fetch the linear solver from the system
417 PetscLinearSolver<Real> & pressure_solver =
418 libMesh::cast_ref<PetscLinearSolver<Real> &>(*pressure_system.get_linear_solver());
419
420 _problem.computeLinearSystemSys(pressure_system, mmat, rhs, false);
421
422 if (_print_fields)
423 {
424 _console << "Pressure matrix" << std::endl;
425 mmat.print();
426 }
427
428 // We compute the normalization factors based on the fluxes
429 Real norm_factor = NS::FV::computeNormalizationFactor(solution, mmat, rhs);
430
431 // We need the non-preconditioned norm to be consistent with the norm factor
432 LibmeshPetscCall(KSPSetNormType(pressure_solver.ksp(), KSP_NORM_UNPRECONDITIONED));
433
434 // Setting the linear tolerances and maximum iteration counts
435 _pressure_linear_control.real_valued_data["abs_tol"] = _pressure_l_abs_tol * norm_factor;
436 pressure_solver.set_solver_configuration(_pressure_linear_control);
437
438 if (_pin_pressure)
439 NS::FV::constrainSystem(mmat, rhs, _pressure_pin_value, _pressure_pin_dof);
440 pressure_system.update();
441
442 // Optionally reuse the pressure preconditioner across SIMPLE iterations to amortize its setup
443 // cost. We rebuild it on the first solve and then once every _pressure_pc_recompute_frequency
444 // solves, reusing it in between. With the default frequency of 1 this rebuilds on every solve.
445 pressure_solver.reuse_preconditioner(
446 (_pressure_pc_solve_counter % _pressure_pc_recompute_frequency) != 0);
447 ++_pressure_pc_solve_counter;
448
449 auto its_res_pair = pressure_solver.solve(mmat, mmat, solution, rhs);
450 pressure_system.update();
451
452 if (_print_fields)
453 {
454 _console << " rhs when we solve pressure " << std::endl;
455 rhs.print();
456 _console << " Pressure " << std::endl;
457 solution.print();
458 _console << "Norm factor " << norm_factor << std::endl;
459 }
460
461 _pressure_system.setSolution(current_local_solution);
462
463 const auto residuals =
464 std::make_pair(its_res_pair.first, pressure_solver.get_initial_residual() / norm_factor);
465
466 _console << " Pressure equation: " << COLOR_GREEN << residuals.second << COLOR_DEFAULT
467 << " Linear its: " << residuals.first << std::endl;
468
469 return residuals;
470}
SIMPLESolveBase::_pressure_l_abs_tol
const Real _pressure_l_abs_tol
Absolute linear tolerance for the pressure equation.
Definition SIMPLESolveBase.h:107
SIMPLESolveBase::_pressure_linear_control
SIMPLESolverConfiguration _pressure_linear_control
Options for the linear solver of the pressure equation.
Definition SIMPLESolveBase.h:103
SIMPLESolveBase::_pressure_pin_value
const Real _pressure_pin_value
The value we want to enforce for pressure.
Definition SIMPLESolveBase.h:119
NS::FV::constrainSystem
void constrainSystem(SparseMatrix< Number > &mx, NumericVector< Number > &rhs, const Real desired_value, const dof_id_type dof_id)
Implicitly constrain the system by adding a factor*(u-u_desired) to it at a desired dof value.
Definition SegregatedSolverUtils.C:180

Referenced by correctVelocity().

◆ solveSolidEnergy()

std::pair< unsigned int, Real > LinearAssemblySegregatedSolve::solveSolidEnergy ( )
protected

Solve an equation which contains the solid energy conservation.

Definition at line 473 of file LinearAssemblySegregatedSolve.C.

474{
475 _problem.setCurrentLinearSystem(_solid_energy_sys_number);
476
477 // We will need some members from the linear system
478 LinearImplicitSystem & system =
479 libMesh::cast_ref<LinearImplicitSystem &>(_solid_energy_system->system());
480
481 // We will need the solution, the right hand side and the matrix
482 NumericVector<Number> & current_local_solution = *(system.current_local_solution);
483 NumericVector<Number> & solution = *(system.solution);
484 SparseMatrix<Number> & mmat = *(system.matrix);
485 NumericVector<Number> & rhs = *(system.rhs);
486
487 // Fetch the linear solver from the system
488 PetscLinearSolver<Real> & solver =
489 libMesh::cast_ref<PetscLinearSolver<Real> &>(*system.get_linear_solver());
490
491 _problem.computeLinearSystemSys(system, mmat, rhs, false);
492
493 if (_print_fields)
494 {
495 _console << "Solid energy matrix" << std::endl;
496 mmat.print();
497 }
498
499 // We compute the normalization factors based on the fluxes
500 Real norm_factor = NS::FV::computeNormalizationFactor(solution, mmat, rhs);
501
502 // We need the non-preconditioned norm to be consistent with the norm factor
503 LibmeshPetscCall(KSPSetNormType(solver.ksp(), KSP_NORM_UNPRECONDITIONED));
504
505 // Setting the linear tolerances and maximum iteration counts
506 _solid_energy_linear_control.real_valued_data["abs_tol"] = _solid_energy_l_abs_tol * norm_factor;
507 solver.set_solver_configuration(_solid_energy_linear_control);
508
509 auto its_res_pair = solver.solve(mmat, mmat, solution, rhs);
510 system.update();
511
512 if (_print_fields)
513 {
514 _console << " rhs when we solve solid energy " << std::endl;
515 rhs.print();
516 _console << " Solid energy " << std::endl;
517 solution.print();
518 _console << "Norm factor " << norm_factor << std::endl;
519 }
520
521 _solid_energy_system->setSolution(current_local_solution);
522
523 const auto residuals =
524 std::make_pair(its_res_pair.first, solver.get_initial_residual() / norm_factor);
525
526 _console << " Solid energy equation: " << COLOR_GREEN << residuals.second << COLOR_DEFAULT
527 << " Linear its: " << residuals.first << std::endl;
528
529 return residuals;
530}
SIMPLESolveBase::_solid_energy_linear_control
SIMPLESolverConfiguration _solid_energy_linear_control
Options for the linear solver of the energy equation.
Definition SIMPLESolveBase.h:151
SIMPLESolveBase::_solid_energy_l_abs_tol
const Real _solid_energy_l_abs_tol
Absolute linear tolerance for the energy equations.
Definition SIMPLESolveBase.h:155

Referenced by solve().

◆ systemsToSolve()

const std::vector< LinearSystem * > LinearAssemblySegregatedSolve::systemsToSolve ( ) const
inline

Return pointers to the systems which are solved for within this object.

Definition at line 41 of file LinearAssemblySegregatedSolve.h.

41{ return _systems_to_solve; }

Referenced by PIMPLE::getTimeIntegrators(), and PIMPLE::relativeSolutionDifferenceNorm().

◆ validParams()

InputParameters LinearAssemblySegregatedSolve::validParams ( )
static

Definition at line 19 of file LinearAssemblySegregatedSolve.C.

20{
21 InputParameters params = SIMPLESolveBase::validParams();
22
23 params.addParam<std::vector<SolverSystemName>>(
24 "active_scalar_systems", {}, "The solver system for each active scalar advection equation.");
25
26 /*
27 * Parameters to control the solution of each scalar advection system
28 */
29 params.addParam<std::vector<Real>>("active_scalar_equation_relaxation",
30 std::vector<Real>(),
31 "The relaxation which should be used for the active scalar "
32 "equations. (=1 for no relaxation, "
33 "diagonal dominance will still be enforced)");
34
35 params.addParam<MultiMooseEnum>("active_scalar_petsc_options",
36 Moose::PetscSupport::getCommonPetscFlags(),
37 "Singleton PETSc options for the active scalar equation(s)");
38 params.addParam<MultiMooseEnum>(
39 "active_scalar_petsc_options_iname",
40 Moose::PetscSupport::getCommonPetscKeys(),
41 "Names of PETSc name/value pairs for the active scalar equation(s)");
42 params.addParam<std::vector<std::string>>(
43 "active_scalar_petsc_options_value",
44 "Values of PETSc name/value pairs (must correspond with \"petsc_options_iname\" for the "
45 "active scalar equation(s)");
46 params.addParam<std::vector<Real>>(
47 "active_scalar_absolute_tolerance",
48 std::vector<Real>(),
49 "The absolute tolerance(s) on the normalized residual(s) of the active scalar equation(s).");
50 params.addRangeCheckedParam<Real>("active_scalar_l_tol",
51 1e-5,
52 "0.0<=active_scalar_l_tol & active_scalar_l_tol<1.0",
53 "The relative tolerance on the normalized residual in the "
54 "linear solver of the active scalar equation(s).");
55 params.addRangeCheckedParam<Real>("active_scalar_l_abs_tol",
56 1e-10,
57 "0.0<active_scalar_l_abs_tol",
58 "The absolute tolerance on the normalized residual in the "
59 "linear solver of the active scalar equation(s).");
60 params.addParam<unsigned int>(
61 "active_scalar_l_max_its",
62 10000,
63 "The maximum allowed iterations in the linear solver of the turbulence equation.");
64
65 params.addParamNamesToGroup(
66 "active_scalar_systems active_scalar_equation_relaxation active_scalar_petsc_options "
67 "active_scalar_petsc_options_iname "
68 "active_scalar_petsc_options_value active_scalar_petsc_options_value "
69 "active_scalar_absolute_tolerance "
70 "active_scalar_l_tol active_scalar_l_abs_tol active_scalar_l_max_its",
71 "Active Scalars Equations");
72
73 /*
74 * Flags to optionally skip solving subsets of the thermal-hydraulics system (useful when
75 * recovering a converged solution and only advancing scalar transport for example).
76 */
77 params.addParam<bool>(
78 "should_solve_momentum", true, "Whether we should solve the momentum predictor/corrector.");
79 params.addParam<bool>(
80 "should_solve_pressure", true, "Whether we should solve the pressure corrector.");
81 params.addParam<bool>(
82 "should_solve_energy", true, "Whether we should solve the fluid energy equation.");
83 params.addParam<bool>(
84 "should_solve_solid_energy", true, "Whether we should solve the solid energy equation.");
85 params.addParam<bool>("should_solve_turbulence",
86 true,
87 "Whether we should solve the turbulence surrogate equations.");
88 params.addParam<bool>(
89 "should_solve_passive_scalars", true, "Whether we should solve passive scalar equations.");
90 params.addParam<bool>(
91 "should_solve_active_scalars", true, "Whether we should solve active scalar equations.");
92 params.addParam<bool>("should_solve_pm_radiation",
93 true,
94 "Whether we should solve participating media radiation equations.");
95 params.addParamNamesToGroup("should_solve_momentum should_solve_pressure should_solve_energy "
96 "should_solve_solid_energy should_solve_turbulence "
97 "should_solve_passive_scalars should_solve_active_scalars",
98 "Solve control");
99
100 /*
101 * Parameter to amortize the (often dominant) pressure preconditioner setup cost. The pressure
102 * operator changes slowly between SIMPLE iterations, so its preconditioner can be reused for
103 * several iterations rather than rebuilt every solve.
104 */
105 params.addRangeCheckedParam<unsigned int>(
106 "pressure_pc_recompute_frequency",
107 1,
108 "pressure_pc_recompute_frequency >= 1",
109 "How often (in pressure corrector solves) to recompute the pressure preconditioner. The "
110 "default of 1 rebuilds it on every solve. A value of N rebuilds it once every N solves and "
111 "reuses it in between, which can substantially reduce the pressure solve cost when the "
112 "preconditioner setup dominates (e.g. algebraic multigrid). Larger values trade more reuse "
113 "for a possibly staler preconditioner (more Krylov iterations); for solves where the "
114 "pressure "
115 "operator changes significantly, prefer a smaller value.");
116 params.addParamNamesToGroup("pressure_pc_recompute_frequency", "Pressure Equation");
117
118 /*
119 * Parameters to control the conjugate heat transfer
120 */
121 params += NS::FV::CHTHandler::validParams();
122
123 return params;
124}
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRangeCheckedParam
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)
NS::FV::CHTHandler::validParams
static InputParameters validParams()
Definition CHTHandler.C:25
SIMPLESolveBase::validParams
static InputParameters validParams()
Definition SIMPLESolveBase.C:15
Moose::PetscSupport::getCommonPetscFlags
MultiMooseEnum getCommonPetscFlags()
Moose::PetscSupport::getCommonPetscKeys
MultiMooseEnum getCommonPetscKeys()

Referenced by PIMPLESolve::validParams(), and SIMPLESolve::validParams().

Member Data Documentation

◆ _active_scalar_absolute_tolerance

const std::vector<Real> LinearAssemblySegregatedSolve::_active_scalar_absolute_tolerance
protected

The user-defined absolute tolerance for determining the convergence in active scalars.

Definition at line 197 of file LinearAssemblySegregatedSolve.h.

Referenced by setupResidualStorage().

◆ _active_scalar_equation_relaxation

const std::vector<Real> LinearAssemblySegregatedSolve::_active_scalar_equation_relaxation
protected

The user-defined relaxation parameter(s) for the active scalar equation(s)

Definition at line 184 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _active_scalar_l_abs_tol

const Real LinearAssemblySegregatedSolve::_active_scalar_l_abs_tol
protected

Absolute linear tolerance for the active scalar equation(s).

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 194 of file LinearAssemblySegregatedSolve.h.

Referenced by solve().

◆ _active_scalar_linear_control

SIMPLESolverConfiguration LinearAssemblySegregatedSolve::_active_scalar_linear_control
protected

Options for the linear solver of the active scalar equation(s)

Definition at line 190 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _active_scalar_petsc_options

Moose::PetscSupport::PetscOptions LinearAssemblySegregatedSolve::_active_scalar_petsc_options
protected

Options which hold the petsc settings for the active scalar equation(s)

Definition at line 187 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _active_scalar_system_names

const std::vector<SolverSystemName>& LinearAssemblySegregatedSolve::_active_scalar_system_names
protected

The names of the active scalar systems.

Definition at line 175 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _active_scalar_system_numbers

std::vector<unsigned int> LinearAssemblySegregatedSolve::_active_scalar_system_numbers
protected

Definition at line 181 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _active_scalar_systems

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_active_scalar_systems
protected

Pointer(s) to the system(s) corresponding to the active scalar equation(s)

Definition at line 151 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

◆ _cht

NS::FV::CHTHandler LinearAssemblySegregatedSolve::_cht
protected

********************** Conjugate heat transfer variables ************** //

Definition at line 202 of file LinearAssemblySegregatedSolve.h.

Referenced by initialSetup(), LinearAssemblySegregatedSolve(), and solve().

◆ _continue_on_max_its

const bool SIMPLESolveBase::_continue_on_max_its
protectedinherited

If solve should continue if maximum number of iterations is hit.

Definition at line 262 of file SIMPLESolveBase.h.

Referenced by solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_absolute_tolerance

const Real SIMPLESolveBase::_energy_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in energy.

Definition at line 244 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_equation_relaxation

const Real SIMPLESolveBase::_energy_equation_relaxation
protectedinherited

The user-defined relaxation parameter for the energy equation.

Definition at line 130 of file SIMPLESolveBase.h.

Referenced by solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_l_abs_tol

const Real SIMPLESolveBase::_energy_l_abs_tol
protectedinherited

Absolute linear tolerance for the energy equations.

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 140 of file SIMPLESolveBase.h.

Referenced by solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_energy_linear_control
protectedinherited

Options for the linear solver of the energy equation.

Definition at line 136 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_energy_petsc_options
protectedinherited

Options which hold the petsc settings for the fluid energy equation.

Definition at line 133 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _energy_sys_number

const unsigned int LinearAssemblySegregatedSolve::_energy_sys_number
protected

The number of the system corresponding to the energy equation.

Definition at line 133 of file LinearAssemblySegregatedSolve.h.

Referenced by solve().

◆ _energy_system

LinearSystem* LinearAssemblySegregatedSolve::_energy_system
protected

Pointer to the linear system corresponding to the fluid energy equation.

Definition at line 136 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

◆ _has_active_scalar_systems

const bool LinearAssemblySegregatedSolve::_has_active_scalar_systems
protected

Boolean for easy check if a active scalar systems shall be solved or not.

Definition at line 178 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _has_energy_system

const bool SIMPLESolveBase::_has_energy_system
protectedinherited

Boolean for easy check if a fluid energy system shall be solved or not.

Definition at line 127 of file SIMPLESolveBase.h.

Referenced by SIMPLESolve::checkIntegrity(), SIMPLESolveNonlinearAssembly::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _has_passive_scalar_systems

const bool SIMPLESolveBase::_has_passive_scalar_systems
protectedinherited

Boolean for easy check if a passive scalar systems shall be solved or not.

Definition at line 163 of file SIMPLESolveBase.h.

Referenced by SIMPLESolve::checkIntegrity(), SIMPLESolveNonlinearAssembly::checkIntegrity(), LinearAssemblySegregatedSolve(), SIMPLESolveBase::SIMPLESolveBase(), SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _has_pm_radiation_systems

const bool SIMPLESolveBase::_has_pm_radiation_systems
protectedinherited

Boolean for easy check if participating media radiation systems shall be solved or not.

Definition at line 187 of file SIMPLESolveBase.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _has_solid_energy_system

const bool SIMPLESolveBase::_has_solid_energy_system
protectedinherited

Boolean for easy check if a solid energy system shall be solved or not.

Definition at line 145 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveNonlinearAssembly::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _has_turbulence_systems

const bool SIMPLESolveBase::_has_turbulence_systems
protectedinherited

Boolean for easy check if a turbulence scalar systems shall be solved or not.

Definition at line 211 of file SIMPLESolveBase.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _momentum_absolute_tolerance

const Real SIMPLESolveBase::_momentum_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in momentum.

Definition at line 238 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveNonlinearAssembly::solve().

◆ _momentum_equation_relaxation

const Real SIMPLESolveBase::_momentum_equation_relaxation
protectedinherited

The user-defined relaxation parameter for the momentum equation.

Definition at line 95 of file SIMPLESolveBase.h.

Referenced by solveMomentumPredictor(), and SIMPLESolveNonlinearAssembly::solveMomentumPredictor().

◆ _momentum_l_abs_tol

const Real SIMPLESolveBase::_momentum_l_abs_tol
protectedinherited

Absolute linear tolerance for the momentum equation(s).

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 89 of file SIMPLESolveBase.h.

Referenced by solveMomentumPredictor(), and SIMPLESolveNonlinearAssembly::solveMomentumPredictor().

◆ _momentum_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_momentum_linear_control
protectedinherited

Options for the linear solver of the momentum equation.

Definition at line 85 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solveMomentumPredictor(), and SIMPLESolveNonlinearAssembly::solveMomentumPredictor().

◆ _momentum_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_momentum_petsc_options
protectedinherited

Options which hold the petsc settings for the momentum equation.

Definition at line 92 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _momentum_system_names

const std::vector<SolverSystemName>& SIMPLESolveBase::_momentum_system_names
protectedinherited

The names of the momentum systems.

Definition at line 82 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), SIMPLESolveBase::SIMPLESolveBase(), and SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly().

◆ _momentum_system_numbers

std::vector<unsigned int> LinearAssemblySegregatedSolve::_momentum_system_numbers
protected

The number(s) of the system(s) corresponding to the momentum equation(s)

Definition at line 110 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), linkRhieChowUserObject(), and solveMomentumPredictor().

◆ _momentum_systems

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_momentum_systems
protected

Pointer(s) to the system(s) corresponding to the momentum equation(s)

Definition at line 113 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), linkRhieChowUserObject(), setupResidualStorage(), and solveMomentumPredictor().

◆ _num_iterations

const unsigned int SIMPLESolveBase::_num_iterations
protectedinherited

The maximum number of momentum-pressure iterations.

Definition at line 259 of file SIMPLESolveBase.h.

Referenced by solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_absolute_tolerance

const std::vector<Real> SIMPLESolveBase::_passive_scalar_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in passive scalars.

Definition at line 250 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_equation_relaxation

const std::vector<Real> SIMPLESolveBase::_passive_scalar_equation_relaxation
protectedinherited

The user-defined relaxation parameter(s) for the passive scalar equation(s)

Definition at line 169 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_l_abs_tol

const Real SIMPLESolveBase::_passive_scalar_l_abs_tol
protectedinherited

Absolute linear tolerance for the passive scalar equation(s).

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 179 of file SIMPLESolveBase.h.

Referenced by solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_passive_scalar_linear_control
protectedinherited

Options for the linear solver of the passive scalar equation(s)

Definition at line 175 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_passive_scalar_petsc_options
protectedinherited

Options which hold the petsc settings for the passive scalar equation(s)

Definition at line 172 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_system_names

const std::vector<SolverSystemName>& SIMPLESolveBase::_passive_scalar_system_names
protectedinherited

The names of the passive scalar systems.

Definition at line 160 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), SIMPLESolveBase::SIMPLESolveBase(), SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly(), and solve().

◆ _passive_scalar_system_numbers

std::vector<unsigned int> SIMPLESolveBase::_passive_scalar_system_numbers
protectedinherited

Definition at line 166 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), SIMPLESolveNonlinearAssembly::SIMPLESolveNonlinearAssembly(), solve(), and SIMPLESolveNonlinearAssembly::solve().

◆ _passive_scalar_systems

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_passive_scalar_systems
protected

Pointer(s) to the system(s) corresponding to the passive scalar equation(s)

Definition at line 145 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

◆ _pin_pressure

const bool SIMPLESolveBase::_pin_pressure
protectedinherited

If the pressure needs to be pinned.

Definition at line 116 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::setupPressurePin(), solvePressureCorrector(), and SIMPLESolveNonlinearAssembly::solvePressureCorrector().

◆ _pm_radiation_absolute_tolerance

const std::vector<Real> SIMPLESolveBase::_pm_radiation_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in participating media radiation.

Definition at line 253 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveBase::SIMPLESolveBase().

◆ _pm_radiation_equation_relaxation

const std::vector<Real> SIMPLESolveBase::_pm_radiation_equation_relaxation
protectedinherited

The user-defined relaxation parameter(s) for the participating media radiation equation(s)

Definition at line 193 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _pm_radiation_l_abs_tol

const Real SIMPLESolveBase::_pm_radiation_l_abs_tol
protectedinherited

Absolute linear tolerance for the participating media radiation equation(s).

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 203 of file SIMPLESolveBase.h.

Referenced by solve().

◆ _pm_radiation_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_pm_radiation_linear_control
protectedinherited

Options for the linear solver of the participating media radiation equation(s)

Definition at line 199 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _pm_radiation_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_pm_radiation_petsc_options
protectedinherited

Options which hold the petsc settings for the participating media radiation equation(s)

Definition at line 196 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _pm_radiation_system_names

const std::vector<SolverSystemName>& SIMPLESolveBase::_pm_radiation_system_names
protectedinherited

The names of the participating media radiation systems.

Definition at line 184 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _pm_radiation_system_numbers

std::vector<unsigned int> SIMPLESolveBase::_pm_radiation_system_numbers
protectedinherited

Definition at line 190 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _pm_radiation_systems

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_pm_radiation_systems
protected

Pointer(s) to the system(s) corresponding to the participting media radiation equation(s)

Definition at line 148 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

◆ _pressure_absolute_tolerance

const Real SIMPLESolveBase::_pressure_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in pressure.

Definition at line 241 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveNonlinearAssembly::solve().

◆ _pressure_l_abs_tol

const Real SIMPLESolveBase::_pressure_l_abs_tol
protectedinherited

Absolute linear tolerance for the pressure equation.

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 107 of file SIMPLESolveBase.h.

Referenced by solvePressureCorrector(), and SIMPLESolveNonlinearAssembly::solvePressureCorrector().

◆ _pressure_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_pressure_linear_control
protectedinherited

Options for the linear solver of the pressure equation.

Definition at line 103 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solvePressureCorrector(), and SIMPLESolveNonlinearAssembly::solvePressureCorrector().

◆ _pressure_pc_recompute_frequency

const unsigned int LinearAssemblySegregatedSolve::_pressure_pc_recompute_frequency
protected

How often (in pressure corrector solves) to recompute the pressure preconditioner.

The pressure (Poisson-like) operator changes slowly between SIMPLE iterations, so reusing the preconditioner - whose setup is often the dominant cost of the pressure solve - for several iterations can substantially reduce the solve time. A value of 1 (the default) rebuilds it on every solve; a value of N rebuilds it once every N solves and reuses it in between.

Definition at line 126 of file LinearAssemblySegregatedSolve.h.

Referenced by solvePressureCorrector().

◆ _pressure_pc_solve_counter

unsigned int LinearAssemblySegregatedSolve::_pressure_pc_solve_counter
protected

Number of pressure corrector solves performed since the start of the current SIMPLE solve, used together with _pressure_pc_recompute_frequency to decide when to reuse the preconditioner.

Definition at line 130 of file LinearAssemblySegregatedSolve.h.

Referenced by solve(), and solvePressureCorrector().

◆ _pressure_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_pressure_petsc_options
protectedinherited

Options which hold the petsc settings for the pressure equation.

Definition at line 110 of file SIMPLESolveBase.h.

Referenced by correctVelocity(), SIMPLESolveBase::SIMPLESolveBase(), and SIMPLESolveNonlinearAssembly::solve().

◆ _pressure_pin_dof

dof_id_type SIMPLESolveBase::_pressure_pin_dof
protectedinherited

The dof ID where the pressure needs to be pinned.

Definition at line 122 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::setupPressurePin(), solvePressureCorrector(), and SIMPLESolveNonlinearAssembly::solvePressureCorrector().

◆ _pressure_pin_value

const Real SIMPLESolveBase::_pressure_pin_value
protectedinherited

The value we want to enforce for pressure.

Definition at line 119 of file SIMPLESolveBase.h.

Referenced by solvePressureCorrector(), and SIMPLESolveNonlinearAssembly::solvePressureCorrector().

◆ _pressure_sys_number

const unsigned int LinearAssemblySegregatedSolve::_pressure_sys_number
protected

The number of the system corresponding to the pressure equation.

Definition at line 116 of file LinearAssemblySegregatedSolve.h.

Referenced by solvePressureCorrector().

◆ _pressure_system

LinearSystem& LinearAssemblySegregatedSolve::_pressure_system
protected

Reference to the linear system corresponding to the pressure equation.

Definition at line 119 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), correctVelocity(), LinearAssemblySegregatedSolve(), linkRhieChowUserObject(), solve(), and solvePressureCorrector().

◆ _pressure_system_name

const SolverSystemName& SIMPLESolveBase::_pressure_system_name
protectedinherited

The name of the pressure system.

Definition at line 100 of file SIMPLESolveBase.h.

◆ _pressure_variable_relaxation

const Real SIMPLESolveBase::_pressure_variable_relaxation
protectedinherited

The user-defined relaxation parameter for the pressure variable.

Definition at line 113 of file SIMPLESolveBase.h.

Referenced by correctVelocity(), and SIMPLESolveNonlinearAssembly::solve().

◆ _print_fields

const bool SIMPLESolveBase::_print_fields
protectedinherited

Debug parameter which allows printing the coupling and solution vectors/matrices.

Definition at line 267 of file SIMPLESolveBase.h.

Referenced by correctVelocity(), SIMPLESolveNonlinearAssembly::solve(), solveAdvectedSystem(), SIMPLESolveNonlinearAssembly::solveAdvectedSystem(), solveMomentumPredictor(), SIMPLESolveNonlinearAssembly::solveMomentumPredictor(), solvePressureCorrector(), SIMPLESolveNonlinearAssembly::solvePressureCorrector(), solveSolidEnergy(), and SIMPLESolveNonlinearAssembly::solveSolidEnergySystem().

◆ _rc_uo

RhieChowMassFlux* LinearAssemblySegregatedSolve::_rc_uo
protected

Pointer to the segregated RhieChow interpolation object.

Definition at line 157 of file LinearAssemblySegregatedSolve.h.

Referenced by correctVelocity(), and linkRhieChowUserObject().

◆ _should_solve_active_scalars

const bool LinearAssemblySegregatedSolve::_should_solve_active_scalars
protected

Definition at line 169 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _should_solve_energy

const bool LinearAssemblySegregatedSolve::_should_solve_energy
protected

Definition at line 165 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _should_solve_momentum

const bool LinearAssemblySegregatedSolve::_should_solve_momentum
protected

Flags controlling which systems are actively solved (can be used with restart to freeze flow)

Definition at line 163 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), linkRhieChowUserObject(), setupResidualStorage(), and solve().

◆ _should_solve_passive_scalars

const bool LinearAssemblySegregatedSolve::_should_solve_passive_scalars
protected

Definition at line 168 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

◆ _should_solve_pm_radiation

const bool LinearAssemblySegregatedSolve::_should_solve_pm_radiation
protected

Definition at line 170 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _should_solve_pressure

const bool LinearAssemblySegregatedSolve::_should_solve_pressure
protected

Definition at line 164 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _should_solve_solid_energy

const bool LinearAssemblySegregatedSolve::_should_solve_solid_energy
protected

Definition at line 166 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _should_solve_turbulence

const bool LinearAssemblySegregatedSolve::_should_solve_turbulence
protected

Definition at line 167 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), setupResidualStorage(), and solve().

◆ _solid_energy_absolute_tolerance

const Real SIMPLESolveBase::_solid_energy_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence in solid energy.

Definition at line 247 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveNonlinearAssembly::solve().

◆ _solid_energy_l_abs_tol

const Real SIMPLESolveBase::_solid_energy_l_abs_tol
protectedinherited

Absolute linear tolerance for the energy equations.

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 155 of file SIMPLESolveBase.h.

Referenced by solveSolidEnergy(), and SIMPLESolveNonlinearAssembly::solveSolidEnergySystem().

◆ _solid_energy_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_solid_energy_linear_control
protectedinherited

Options for the linear solver of the energy equation.

Definition at line 151 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), solveSolidEnergy(), and SIMPLESolveNonlinearAssembly::solveSolidEnergySystem().

◆ _solid_energy_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_solid_energy_petsc_options
protectedinherited

Options which hold the petsc settings for the fluid energy equation.

Definition at line 148 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _solid_energy_sys_number

const unsigned int LinearAssemblySegregatedSolve::_solid_energy_sys_number
protected

The number of the system corresponding to the solid energy equation.

Definition at line 139 of file LinearAssemblySegregatedSolve.h.

Referenced by solveSolidEnergy().

◆ _solid_energy_system

LinearSystem* LinearAssemblySegregatedSolve::_solid_energy_system
protected

Pointer to the linear system corresponding to the solid energy equation.

Definition at line 142 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), solve(), and solveSolidEnergy().

◆ _systems_to_solve

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_systems_to_solve
protected

Shortcut to every linear system that we solve for here.

Definition at line 160 of file LinearAssemblySegregatedSolve.h.

Referenced by LinearAssemblySegregatedSolve(), and systemsToSolve().

◆ _turbulence_absolute_tolerance

const std::vector<Real> SIMPLESolveBase::_turbulence_absolute_tolerance
protectedinherited

The user-defined absolute tolerance for determining the convergence turbulence variables.

Definition at line 256 of file SIMPLESolveBase.h.

Referenced by setupResidualStorage(), and SIMPLESolveBase::SIMPLESolveBase().

◆ _turbulence_equation_relaxation

const std::vector<Real> SIMPLESolveBase::_turbulence_equation_relaxation
protectedinherited

The user-defined relaxation parameter(s) for the turbulence equation(s)

Definition at line 217 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_field_min_limit

std::vector<Real> SIMPLESolveBase::_turbulence_field_min_limit
protectedinherited

The user-defined lower limit for turbulent quantities e.g. k, eps/omega, etc..

Definition at line 223 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_field_relaxation

std::vector<Real> SIMPLESolveBase::_turbulence_field_relaxation
protectedinherited

The user-defined relaxation parameter(s) for the turbulence field(s)

Definition at line 220 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_l_abs_tol

const Real SIMPLESolveBase::_turbulence_l_abs_tol
protectedinherited

Absolute linear tolerance for the turbulence equation(s).

We need to store this, because it needs to be scaled with a representative flux.

Definition at line 233 of file SIMPLESolveBase.h.

Referenced by solve().

◆ _turbulence_linear_control

SIMPLESolverConfiguration SIMPLESolveBase::_turbulence_linear_control
protectedinherited

Options for the linear solver of the turbulence equation(s)

Definition at line 229 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_petsc_options

Moose::PetscSupport::PetscOptions SIMPLESolveBase::_turbulence_petsc_options
protectedinherited

Options which hold the petsc settings for the turbulence equation(s)

Definition at line 226 of file SIMPLESolveBase.h.

Referenced by SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_system_names

const std::vector<SolverSystemName>& SIMPLESolveBase::_turbulence_system_names
protectedinherited

The names of the turbulence systems.

Definition at line 208 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), setupResidualStorage(), SIMPLESolveBase::SIMPLESolveBase(), and solve().

◆ _turbulence_system_numbers

std::vector<unsigned int> SIMPLESolveBase::_turbulence_system_numbers
protectedinherited

Definition at line 214 of file SIMPLESolveBase.h.

Referenced by LinearAssemblySegregatedSolve(), and solve().

◆ _turbulence_systems

std::vector<LinearSystem *> LinearAssemblySegregatedSolve::_turbulence_systems
protected

Pointer(s) to the system(s) corresponding to the turbulence equation(s)

Definition at line 154 of file LinearAssemblySegregatedSolve.h.

Referenced by SIMPLESolve::checkIntegrity(), LinearAssemblySegregatedSolve(), and solve().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:11 for https://mooseframework.inl.gov by doxygen 1.9.8