https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SIMPLENonlinearAssembly Class Reference

Executioner set up to solve a thermal-hydraulics problem using the SIMPLENonlinearAssembly algorithm. More...

#include <SIMPLENonlinearAssembly.h>

Inheritance diagram for SIMPLENonlinearAssembly:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 SIMPLENonlinearAssembly (const InputParameters &parameters)
 
virtual void init () override
 
virtual void execute () override
 
virtual bool lastSolveConverged () const override
 
virtual unsigned int getIterationNumberOutput () const
 
virtual void setIterationNumberOutput (unsigned int iteration_number)
 
virtual void preProblemInit ()
 
virtual void preExecute ()
 
virtual void postExecute ()
 
virtual void preSolve ()
 
virtual void postSolve ()
 
virtual Problem & problem ()
 
FEProblemBase & feProblem ()
 
virtual std::string getTimeStepperName () const
 
virtual std::vector< std::string > getTimeIntegratorNames () const
 
virtual void parentOutputPositionChanged ()
 
FixedPointSolve & fixedPointSolve ()
 
const bool & verbose () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
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
 
PerfGraph & perfGraph ()
 
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
 
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
 
virtual void store (nlohmann::json &json) const
 
virtual bool shouldStore () const
 
virtual void declareLateValues ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static MooseEnum iterationMethods ()
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

virtual PostprocessorValue & addAttributeReporter (const std::string &name, Real initial_value=0)
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) 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
 
T & declareUnusedValue (Args &&... args)
 
const ReporterName & getReporterName (const std::string &param_name) const
 
virtual void addReporterDependencyHelper (const ReporterName &)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 

Protected Attributes

SIMPLESolveNonlinearAssembly _simple_solve
 The SIMPLE solve object that relies on nonlinear assembly routines. More...
 
FEProblemBase & _problem
 
Real _system_time
 
int & _time_step
 
Real & _time
 
unsigned int _output_iteration_number
 
FEProblemBase & _fe_problem
 
MooseEnum _iteration_method
 
std::unique_ptr< FixedPointSolve > _fixed_point_solve
 
std::string _restart_file_base
 
const bool & _verbose
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Detailed Description

Executioner set up to solve a thermal-hydraulics problem using the SIMPLENonlinearAssembly algorithm.

It utilizes segregated linearized systems which are solved using a fixed-point iteration.

Definition at line 20 of file SIMPLENonlinearAssembly.h.

Constructor & Destructor Documentation

◆ SIMPLENonlinearAssembly()

SIMPLENonlinearAssembly::SIMPLENonlinearAssembly ( const InputParameters &  parameters)

Definition at line 26 of file SIMPLENonlinearAssembly.C.

27  : SteadyBase(parameters), _simple_solve(*this)
28 {
29  _fixed_point_solve->setInnerSolve(_simple_solve);
30 }
SteadyBase::SteadyBase
SteadyBase(const InputParameters &parameters)
SteadyBase::parameters
const InputParameters & parameters() const
SIMPLENonlinearAssembly::_simple_solve
SIMPLESolveNonlinearAssembly _simple_solve
The SIMPLE solve object that relies on nonlinear assembly routines.
Definition: SIMPLENonlinearAssembly.h:31
SteadyBase::_fixed_point_solve
std::unique_ptr< FixedPointSolve > _fixed_point_solve

Member Function Documentation

◆ init()

void SIMPLENonlinearAssembly::init ( )
overridevirtual

Reimplemented from SteadyBase.

Definition at line 33 of file SIMPLENonlinearAssembly.C.

34 {
35  _problem.execute(EXEC_PRE_MULTIAPP_SETUP);
36  _problem.initialSetup();
37  _simple_solve.checkIntegrity();
38  _simple_solve.linkRhieChowUserObject();
39  _simple_solve.setupPressurePin();
40 }
SIMPLESolveNonlinearAssembly::linkRhieChowUserObject
virtual void linkRhieChowUserObject() override
Fetch the Rhie Chow user object that is reponsible for determining face velocities and mass flux...
Definition: SIMPLESolveNonlinearAssembly.C:228
FEProblemBase::execute
virtual void execute(const ExecFlagType &exec_type)
FEProblemBase::initialSetup
void initialSetup() override
SteadyBase::_problem
FEProblemBase & _problem
SIMPLENonlinearAssembly::_simple_solve
SIMPLESolveNonlinearAssembly _simple_solve
The SIMPLE solve object that relies on nonlinear assembly routines.
Definition: SIMPLENonlinearAssembly.h:31
SIMPLESolveBase::setupPressurePin
void setupPressurePin()
Setup pressure pin if there is need for one.
Definition: SIMPLESolveBase.C:478
SIMPLESolveNonlinearAssembly::checkIntegrity
virtual void checkIntegrity() override
Check if the user defined time kernels.
Definition: SIMPLESolveNonlinearAssembly.C:775

◆ validParams()

InputParameters SIMPLENonlinearAssembly::validParams ( )
static

Definition at line 17 of file SIMPLENonlinearAssembly.C.

18 {
19  InputParameters params = SteadyBase::validParams();
20  params.addClassDescription("Solves the Navier-Stokes equations using the "
21  "SIMPLENonlinearAssembly algorithm.");
22  params += SIMPLESolveNonlinearAssembly::validParams();
23  return params;
24 }
SteadyBase::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _simple_solve

SIMPLESolveNonlinearAssembly SIMPLENonlinearAssembly::_simple_solve
protected

The SIMPLE solve object that relies on nonlinear assembly routines.

Definition at line 31 of file SIMPLENonlinearAssembly.h.

Referenced by init(), and SIMPLENonlinearAssembly().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:51:10 for https://mooseframework.inl.gov by   doxygen 1.8.14