https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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
PIMPLE Class Reference

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

#include <PIMPLE.h>

Inheritance diagram for PIMPLE:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 PIMPLE (const InputParameters &parameters)
 
virtual void init () override
 
virtual Real relativeSolutionDifferenceNorm (bool check_aux) const override
 
virtual void execute () override
 
virtual void takeStep (Real input_dt=-1.0)
 
virtual Real computeConstrainedDT ()
 
virtual void estimateTimeError ()
 
virtual Real getDT ()
 
virtual bool keepGoing ()
 
virtual bool lastSolveConverged () const override
 
virtual void preExecute () override
 
virtual void postExecute () override
 
void computeDT ()
 
virtual void preStep ()
 
virtual void postStep ()
 
virtual void incrementStepOrReject ()
 
virtual void endStep (Real input_time=-1.0)
 
virtual void setTargetTime (Real target_time)
 
virtual Real getTime () const
 
virtual Real getTargetTime ()
 
virtual void setTime (Real t)
 
virtual void setTimeOld (Real t)
 
Real computeSolutionChangeNorm (bool check_aux, bool normalize_by_dt) const
 
TimeStepper * getTimeStepper ()
 
const TimeStepper * getTimeStepper () const
 
void setTimeStepper (TimeStepper &ts)
 
virtual std::string getTimeStepperName () const override
 
virtual std::vector< std::string > getTimeIntegratorNames () const override
 
Moose::TimeIntegratorType getTimeScheme () const
 
std::set< Real > & syncTimes ()
 
Real & dtMax ()
 
Real & dtMin ()
 
Real getStartTime () const
 
Real getEndTime () const
 
Real & endTime ()
 
Real & timestepTol ()
 
virtual void setTimestepTolerance (const Real &tolerance)
 
bool atSyncPoint ()
 
Real unconstrainedDT ()
 
void parentOutputPositionChanged () override
 
virtual void forceNumSteps (const unsigned int num_steps)
 
virtual SolveObject * timeStepSolveObject ()
 
bool convergedToSteadyState () const
 
virtual void preProblemInit ()
 
virtual void preSolve ()
 
virtual void postSolve ()
 
virtual Problem & problem ()
 
FEProblemBase & feProblem ()
 
FixedPointSolve & fixedPointSolve ()
 
const bool & verbose () const
 
void registerSolveObject (const SolveObject &so)
 
bool hasSolveObject () const
 
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
 
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 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 void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static InputParameters defaultSteadyStateConvergenceParams ()
 
static MooseEnum iterationMethods ()
 

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::set< TimeIntegrator * > getTimeIntegrators () const override
 
void setupTimeIntegrator ()
 
virtual PostprocessorValue & addAttributeReporter (const std::string &name, Real initial_value=0)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) 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 ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
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

PIMPLESolve _pimple_solve
 The solve object performing the PIMPLE iteration.
 
FEProblemBase & _problem
 
AuxiliarySystem & _aux
 
Moose::TimeIntegratorType _time_scheme
 
TimeStepper * _time_stepper
 
int & _t_step
 
Real & _time
 
Real & _time_old
 
Real & _dt
 
Real & _dt_old
 
Real & _unconstrained_dt
 
bool & _at_sync_point
 
bool & _last_solve_converged
 
bool _xfem_repeat_step
 
Real _end_time
 
Real _dtmin
 
Real _dtmax
 
unsigned int _num_steps
 
int _n_startup_steps
 
const bool _steady_state_detection
 
const Real _steady_state_start_time
 
std::set< Real > & _sync_times
 
bool _abort
 
const bool _error_on_dtmin
 
bool & _time_interval
 
Real _next_interval_output_time
 
Real _time_interval_output_interval
 
Real _start_time
 
Real _timestep_tolerance
 
Real & _target_time
 
bool _use_multiapp_dt
 
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
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
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
 

Private Member Functions

void constrainDTFromMultiApp (Real &dt_cur, std::ostringstream &diag, const ExecFlagType &execute_on) const
 
const ReporterValueName & getReporterValueName (const std::string &param_name) const
 
bool reportersAdded () const
 
void possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") 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
 
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
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) 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
 

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

std::optional< int > _test_restep_step
 
std::optional< Real > _test_restep_time
 
bool _testing_restep
 
std::vector< const SolveObject * > _solve_objects
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
const MooseObject & _reporter_moose_object
 
const InputParameters & _reporter_params
 
const std::string & _reporter_name
 
FEProblemBase & _reporter_fe_problem
 
ReporterData & _reporter_data
 
std::vector< std::unique_ptr< UnusedWrapperBase > > _unused_values
 
MooseApp & _oi_moose_app
 
OutputWarehouse & _oi_output_warehouse
 
std::set< OutputName > _oi_outputs
 
const InputParameters & _ri_params
 
FEProblemBase & _ri_fe_problem_base
 
const ReporterData & _ri_reporter_data
 
const MooseObject & _ri_moose_object
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 

Detailed Description

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

It utilizes segregated linear systems which are solved using a fixed-point iteration within time steps.

Definition at line 20 of file PIMPLE.h.

Constructor & Destructor Documentation

◆ PIMPLE()

PIMPLE::PIMPLE ( const InputParameters &  parameters)

Definition at line 32 of file PIMPLE.C.

32 : TransientBase(parameters), _pimple_solve(*this)
33{
34 _fixed_point_solve->setInnerSolve(_pimple_solve);
35}
TransientBase::_fixed_point_solve
std::unique_ptr< FixedPointSolve > _fixed_point_solve
TransientBase::parameters
const InputParameters & parameters() const
PIMPLE::_pimple_solve
PIMPLESolve _pimple_solve
The solve object performing the PIMPLE iteration.
Definition PIMPLE.h:35
SIMPLESolveBase::setInnerSolve
virtual void setInnerSolve(SolveObject &) override
Definition SIMPLESolveBase.h:48

Member Function Documentation

◆ getTimeIntegrators()

std::set< TimeIntegrator * > PIMPLE::getTimeIntegrators ( ) const
overrideprotectedvirtual

Implements TransientBase.

Definition at line 63 of file PIMPLE.C.

64{
65 // We use a set because time integrators were added to every system, and we want a unique
66 std::set<TimeIntegrator *> tis;
67 // Get all time integrators from the systems in the FEProblemSolve
68 for (const auto sys : _pimple_solve.systemsToSolve())
69 for (const auto & ti : sys->getTimeIntegrators())
70 tis.insert(ti.get());
71 return tis;
72}
for
for(PetscInt i=0;i< nvars;++i)
PIMPLE::getTimeIntegrators
virtual std::set< TimeIntegrator * > getTimeIntegrators() const override
Definition PIMPLE.C:63
libMesh::ReferenceElem::get
const Elem & get(const ElemType type_in)

◆ init()

void PIMPLE::init ( )
overridevirtual

Reimplemented from TransientBase.

Definition at line 38 of file PIMPLE.C.

39{
40 _pimple_solve.initialSetup();
41 TransientBase::init();
42 _pimple_solve.linkRhieChowUserObject();
43 _pimple_solve.setupPressurePin();
44}
LinearAssemblySegregatedSolve::linkRhieChowUserObject
virtual void linkRhieChowUserObject() override
Fetch the Rhie Chow user object that is reponsible for determining face velocities and mass flux.
Definition LinearAssemblySegregatedSolve.C:278
SIMPLESolveBase::setupPressurePin
void setupPressurePin()
Setup pressure pin if there is need for one.
Definition SIMPLESolveBase.C:698
TransientBase::init
virtual void init() override

◆ relativeSolutionDifferenceNorm()

Real PIMPLE::relativeSolutionDifferenceNorm ( bool  check_aux) const
overridevirtual

Implements TransientBase.

Definition at line 47 of file PIMPLE.C.

48{
49 if (check_aux)
50 return _aux.solution().l2_norm_diff(_aux.solutionOld()) / _aux.solution().l2_norm();
51 else
52 {
53 // Default criterion for now until we add a "steady-state-convergence-object" option
54 Real residual = 0;
55 for (const auto sys : _pimple_solve.systemsToSolve())
56 residual +=
57 std::pow(sys->solution().l2_norm_diff(sys->solutionOld()) / sys->solution().l2_norm(), 2);
58 return std::sqrt(residual);
59 }
60}
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition ExpressionBuilder.h:690
AuxiliarySystem::solutionOld
NumericVector< Number > & solutionOld()
AuxiliarySystem::solution
NumericVector< Number > & solution()
TransientBase::_aux
AuxiliarySystem & _aux
libMesh::NumericVector::l2_norm_diff
Real l2_norm_diff(const NumericVector< T > &other_vec) const
libMesh::NumericVector::l2_norm
virtual Real l2_norm() const=0
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ validParams()

InputParameters PIMPLE::validParams ( )
static

Definition at line 21 of file PIMPLE.C.

22{
23 InputParameters params = TransientBase::validParams();
24 params.addClassDescription(
25 "Solves the transient Navier-Stokes equations using the PIMPLE algorithm and "
26 "linear finite volume variables.");
27 params += PIMPLESolve::validParams();
28
29 return params;
30}
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
PIMPLESolve::validParams
static InputParameters validParams()
Definition PIMPLESolve.C:18
TransientBase::validParams
static InputParameters validParams()

Member Data Documentation

◆ _pimple_solve

PIMPLESolve PIMPLE::_pimple_solve
protected

The solve object performing the PIMPLE iteration.

Definition at line 35 of file PIMPLE.h.

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

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