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

#include <PIMPLE.h>

Inheritance diagram for PIMPLE:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PIMPLE (const InputParameters &parameters)

virtual void	init () override

virtual Real	relativeSolutionDifferenceNorm () 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

virtual 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	getSolutionChangeNorm ()

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 ()

virtual void	preProblemInit ()

virtual void	preSolve ()

virtual void	postSolve ()

virtual Problem &	problem ()

FEProblemBase &	feProblem ()

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 std::set< TimeIntegrator * >	getTimeIntegrators () const override

void	setupTimeIntegrator ()

bool	convergedToSteadyState () const

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
PIMPLESolve	_pimple_solve
	The solve object performing the PIMPLE iteration. More...

FEProblemBase &	_problem

AuxiliarySystem &	_aux

const bool	_check_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

bool	_steady_state_detection

Real	_steady_state_tolerance

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

Real &	_solution_change_norm

const bool	_normalize_solution_diff_norm_by_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

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 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.

                                                  : TransientBase(parameters), _pimple_solve(*this)
 {
   _fixed_point_solve->setInnerSolve(_pimple_solve);
 }

Member Function Documentation

◆ getTimeIntegrators()

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

overrideprotectedvirtual

Implements TransientBase.

Definition at line 62 of file PIMPLE.C.

 {
   // We use a set because time integrators were added to every system, and we want a unique
   std::set<TimeIntegrator *> tis;
   // Get all time integrators from the systems in the FEProblemSolve
   for (const auto sys : _pimple_solve.systemsToSolve())
     for (const auto & ti : sys->getTimeIntegrators())
       tis.insert(ti.get());
   return tis;
 }

◆ init()

void PIMPLE::init ( )

overridevirtual

Reimplemented from TransientBase.

Definition at line 38 of file PIMPLE.C.

 {
   TransientBase::init();
   _pimple_solve.linkRhieChowUserObject();
   _pimple_solve.setupPressurePin();
 }

◆ relativeSolutionDifferenceNorm()

Real PIMPLE::relativeSolutionDifferenceNorm ( )

overridevirtual

Implements TransientBase.

Definition at line 46 of file PIMPLE.C.

 {
   if (_check_aux)
     return _aux.solution().l2_norm_diff(_aux.solutionOld()) / _aux.solution().l2_norm();
   else
   {
     // Default criterion for now until we add a "steady-state-convergence-object" option
     Real residual = 0;
     for (const auto sys : _pimple_solve.systemsToSolve())
       residual +=
           std::pow(sys->solution().l2_norm_diff(sys->solutionOld()) / sys->solution().l2_norm(), 2);
     return std::sqrt(residual);
   }
 }

◆ validParams()

InputParameters PIMPLE::validParams ( )

static

Definition at line 21 of file PIMPLE.C.

 {
   InputParameters params = TransientBase::validParams();
   params.addClassDescription(
       "Solves the transient Navier-Stokes equations using the PIMPLE algorithm and "
       "linear finite volume variables.");
   params += PIMPLESolve::validParams();
 
   return params;
 }

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:

navier_stokes/include/executioners/PIMPLE.h
navier_stokes/src/executioners/PIMPLE.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes