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

Interface for objects that needs transient capabilities. More...

#include <TransientInterface.h>

Inheritance diagram for TransientInterface:
[legend]

Public Member Functions

 TransientInterface (const MooseObject *moose_object)
 
virtual ~TransientInterface ()
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 Create a functor state argument that corresponds to the implicit state of this object. More...
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 If the object is using implicit or explicit form. More...
 
Real & _t
 Time. More...
 
const Real & _t_old
 Old time. More...
 
int & _t_step
 The number of the time step. More...
 
Real & _dt
 Time step size. More...
 
Real & _dt_old
 Size of the old time step. More...
 
bool _is_transient
 

Private Attributes

const std::string _ti_name
 

Detailed Description

Interface for objects that needs transient capabilities.

Definition at line 31 of file TransientInterface.h.

Constructor & Destructor Documentation

◆ TransientInterface()

TransientInterface::TransientInterface ( const MooseObject *  moose_object)

Definition at line 27 of file TransientInterface.C.

28  : _ti_params(moose_object->parameters()),
29  _ti_feproblem(*_ti_params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
30  _is_implicit(_ti_params.have_parameter<bool>("implicit") ? _ti_params.get<bool>("implicit")
31  : true),
32  _t(_is_implicit ? _ti_feproblem.time() : _ti_feproblem.timeOld()),
33  _t_old(_ti_feproblem.timeOld()),
34  _t_step(_ti_feproblem.timeStep()),
35  _dt(_ti_feproblem.dt()),
36  _dt_old(_ti_feproblem.dtOld()),
37  _is_transient(_ti_feproblem.isTransient()),
38  _ti_name(MooseUtils::shortName(_ti_params.get<std::string>("_object_name")))
39 {
40 }
FEProblemBase::dtOld
virtual Real & dtOld() const
Definition: FEProblemBase.h:518
FEProblemBase::time
virtual Real & time() const
Definition: FEProblemBase.h:514
TransientInterface::_ti_feproblem
FEProblemBase & _ti_feproblem
Definition: TransientInterface.h:50
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
Definition: InputParameters.h:2172
TransientInterface::_dt_old
Real & _dt_old
Size of the old time step.
Definition: TransientInterface.h:73
InputParameters::getCheckedPointerParam
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
Definition: InputParameters.h:1612
TransientInterface::_dt
Real & _dt
Time step size.
Definition: TransientInterface.h:70
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblemBase.h:132
MooseUtils::shortName
std::string shortName(const std::string &name)
Function for stripping name after the file / in parser block.
Definition: MooseUtils.C:608
TransientInterface::_t_step
int & _t_step
The number of the time step.
Definition: TransientInterface.h:67
TransientInterface::_t_old
const Real & _t_old
Old time.
Definition: TransientInterface.h:64
TransientInterface::_ti_params
const InputParameters & _ti_params
Definition: TransientInterface.h:48
FEProblemBase::timeStep
virtual int & timeStep() const
Definition: FEProblemBase.h:516
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
A wrapper around the Parameters base class method.
Definition: InputParameters.h:2230
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseBaseParameterInterface.h:62
FEProblemBase::timeOld
virtual Real & timeOld() const
Definition: FEProblemBase.h:515
FEProblemBase::isTransient
virtual bool isTransient() const override
Definition: FEProblemBase.h:525
TransientInterface::_ti_name
const std::string _ti_name
Definition: TransientInterface.h:79
FEProblemBase::dt
virtual Real & dt() const
Definition: FEProblemBase.h:517
TransientInterface::_is_implicit
bool _is_implicit
If the object is using implicit or explicit form.
Definition: TransientInterface.h:58

◆ ~TransientInterface()

TransientInterface::~TransientInterface ( )
virtual

Definition at line 42 of file TransientInterface.C.

42 {}

Member Function Documentation

◆ determineState()

Moose::StateArg TransientInterface::determineState ( ) const
inline

Create a functor state argument that corresponds to the implicit state of this object.

If we are implicit then we will return the current state. If we are not, then we will return the old state

Definition at line 83 of file TransientInterface.h.

Referenced by LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryGradientMatrixContribution(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryGradientRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryGradientRHSContribution(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryGradientRHSContribution(), LinearFVAnisotropicDiffusion::computeBoundaryMatrixContribution(), LinearFVDiffusion::computeBoundaryMatrixContribution(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryNormalGradient(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryValueMatrixContribution(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorRobinBC::computeBoundaryValueRHSContribution(), SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), LinearFVAnisotropicDiffusion::computeFluxMatrixContribution(), LinearFVDiffusion::computeFluxMatrixContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), LinearFVReaction::computeMatrixContribution(), LayeredSideDiffusiveFluxAverage::computeQpIntegral(), SideIntegralFunctorUserObject::computeQpIntegral(), SideIntegralVariableUserObject::computeQpIntegral(), ElementIntegralFunctorUserObject::computeQpIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), ParsedMaterialHelper< is_ad >::computeQpProperties(), FVDiffusionInterface::computeQpResidual(), FVTwoVarContinuityConstraint::computeQpResidual(), FVOneVarDiffusionInterface::computeQpResidual(), FVFunctorTimeKernel::computeQpResidual(), FVMatAdvection::computeQpResidual(), FVAdvection::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVConstantScalarOutflowBC::computeQpResidual(), FVFunctorNeumannBC::computeQpResidual(), FVAnisotropicDiffusion::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVDivergence::computeQpResidual(), UserForcingFunctorNodalKernel::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FVDiffusion::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), DiffusionLHDGPrescribedGradientBC::computeResidual(), LinearFVSource::computeRightHandSideContribution(), TimeDerivativeAux::computeValue(), SecondTimeDerivativeAux::computeValue(), AdvectiveFluxAux::computeValue(), ParsedAux::computeValue(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SideValueSampler::execute(), PositionsFunctorValueSampler::execute(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), FunctorPositions::initialize(), FunctorTimes::initialize(), FunctorExtremaPositions::initialize(), ParsedDownSelectionPositions::initialize(), IPHDGAssemblyHelper::lmDirichlet(), IPHDGAssemblyHelper::lmPrescribedFlux(), AdvectionIPHDGAssemblyHelper::scalarDirichlet(), DiffusionIPHDGAssemblyHelper::scalarDirichlet(), DiffusionLHDGAssemblyHelper::scalarDirichletResidual(), DiffusionLHDGAssemblyHelper::scalarVolumeResidual(), and DiffusionLHDGAssemblyHelper::vectorDirichletResidual().

84 {
85  return _is_implicit ? Moose::currentState() : Moose::oldState();
86 }
Moose::oldState
StateArg oldState()
Definition: MooseFunctorArguments.h:157
Moose
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
Definition: SetAdaptivityOptionsAction.h:14
Moose::currentState
StateArg currentState()
Definition: MooseFunctorArguments.h:151
TransientInterface::_is_implicit
bool _is_implicit
If the object is using implicit or explicit form.
Definition: TransientInterface.h:58

◆ isImplicit()

bool TransientInterface::isImplicit ( )
inline

Definition at line 38 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

38 { return _is_implicit; }
TransientInterface::_is_implicit
bool _is_implicit
If the object is using implicit or explicit form.
Definition: TransientInterface.h:58

◆ validParams()

InputParameters TransientInterface::validParams ( )
static

Definition at line 14 of file TransientInterface.C.

Referenced by TransientMultiApp::validParams(), Convergence::validParams(), InterfaceUserObjectBase::validParams(), InternalSideUserObject::validParams(), ElementIndicator::validParams(), ElementUserObject::validParams(), Control::validParams(), ResidualObject::validParams(), LinearSystemContributionObject::validParams(), DomainUserObject::validParams(), LinearFVBoundaryCondition::validParams(), FVInterfaceKernel::validParams(), FVBoundaryCondition::validParams(), and MaterialBase::validParams().

15 {
16 
17  InputParameters params = emptyInputParameters();
18  params.addParam<bool>(
19  "implicit",
20  true,
21  "Determines whether this object is calculated using an implicit or explicit form");
22 
23  params.addParamNamesToGroup("implicit", "Advanced");
24  return params;
25 }
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition: InputParameters.h:66
emptyInputParameters
InputParameters emptyInputParameters()
Definition: InputParameters.C:30
InputParameters::addParam
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an optional parameter and a documentation string to the InputParameters object...
Definition: InputParameters.h:1654
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...
Definition: InputParameters.C:930

Member Data Documentation

◆ _dt

Real& TransientInterface::_dt
protected

Time step size.

Definition at line 70 of file TransientInterface.h.

Referenced by InterfaceQpValueUserObject::computeRealValue(), ForcingFunctionAux::computeValue(), TimeIntegratedPostprocessor::execute(), PIDTransientControl::execute(), VariableTimeIntegrationAux::getIntegralValue(), and PIDChainControl::updateValues().

◆ _dt_old

Real& TransientInterface::_dt_old
protected

Size of the old time step.

Definition at line 73 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _is_implicit

bool TransientInterface::_is_implicit
protected

If the object is using implicit or explicit form.

This does NOT mean time scheme, but which values are going to be used in the object - either from current time or old time. Note that even explicit schemes have implicit form (it is the time derivative "kernel")

Definition at line 58 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), Kernel::computeResidualAndJacobian(), NodalBC::computeResidualAndJacobian(), IntegratedBC::computeResidualAndJacobian(), determineState(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient
protected

Definition at line 76 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _t

Real& TransientInterface::_t
protected

Time.

Definition at line 61 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), AnalyticalIndicator::computeQpIntegral(), FunctionElementIntegral::computeQpIntegral(), ElementL2Error::computeQpIntegral(), ElementHCurlSemiError::computeQpIntegral(), ElementHDivSemiError::computeQpIntegral(), ElementL1Error::computeQpIntegral(), FunctionElementIntegralUserObject::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), FunctionDiffusion::computeQpJacobian(), VectorFunctionReaction::computeQpJacobian(), ArrayBodyForce::computeQpResidual(), FunctionDiffusion::computeQpResidual(), ConvectiveFluxBC::computeQpResidual(), ADVectorFunctionNeumannBC::computeQpResidual(), FunctionGradientNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), ADFunctionNeumannBC::computeQpResidual(), FVFunctionNeumannBC::computeQpResidual(), FunctionNeumannBC::computeQpResidual(), VectorCurlPenaltyDirichletBC::computeQpResidual(), VectorFunctionReaction::computeQpResidual(), VectorDivPenaltyDirichletBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), VectorPenaltyDirichletBC::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), FVBodyForce::computeQpResidual(), ADConservativeAdvectionBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), SinDirichletBC::computeQpResidual(), ADFunctionPenaltyDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), ADVectorFunctionDirichletBC::computeQpValue(), ADFunctionDirichletBC::computeQpValue(), FunctionDirichletBC::computeQpValue(), TimedSubdomainModifier::computeSubdomainID(), FunctionArrayAux::computeValue(), ForcingFunctionAux::computeValue(), ArrayParsedAux::computeValue(), ParsedAux::computeValue(), ParsedVectorAux::computeValue(), FunctionScalarAux::computeValue(), VectorFunctionAux::computeValue(), FunctionAux::computeValue(), SolutionScalarAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), ConditionalFunctionEnableControl::conditionMet(), TimesEnableControl::conditionMet(), TimePeriod::conditionMet(), PIDChainControl::execute(), LineFunctionSampler::execute(), NodalL2Error::execute(), IterationInfo::execute(), SmootherChainControl::execute(), BoolFunctionControl::execute(), GetFunctionValueChainControl::execute(), ParsedChainControl::execute(), PIDTransientControl::execute(), RealFunctionControl::execute(), LeastSquaresFitHistory::execute(), TimeExtremeValue::execute(), UserForcingFunction::f(), ParsedPostprocessor::finalize(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), ParsedDownSelectionPositions::initialize(), ActivateElementsByPath::isElementActivated(), SolutionUserObject::solutionSampleTime(), SolutionUserObjectBase::updateExodusTimeInterpolation(), and ParsedConvergence::updateFunctionSymbolValues().

◆ _t_old

const Real& TransientInterface::_t_old
protected

Old time.

Definition at line 64 of file TransientInterface.h.

Referenced by FVFunctionDirichletBC::boundaryValue(), and TimedSubdomainModifier::computeSubdomainID().

◆ _t_step

int& TransientInterface::_t_step
protected

The number of the time step.

Definition at line 67 of file TransientInterface.h.

Referenced by AccumulateReporter::execute(), IterationInfo::execute(), PIDTransientControl::execute(), ChangeOverTimePostprocessor::finalize(), and ChangeOverFixedPointPostprocessor::finalize().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem
protected

Definition at line 50 of file TransientInterface.h.

Referenced by Function::evaluate(), Function::evaluateDotHelper(), Function::evaluateGradientHelper(), Function::evaluateHelper(), PiecewiseConstantFromCSV::initialSetup(), and PiecewiseConstantFromCSV::PiecewiseConstantFromCSV().

◆ _ti_name

const std::string TransientInterface::_ti_name
private

Definition at line 79 of file TransientInterface.h.

◆ _ti_params

const InputParameters& TransientInterface::_ti_params
protected

Definition at line 48 of file TransientInterface.h.

The documentation for this class was generated from the following files:
Generated on Fri Jul 25 2025 05:09:12 for https://mooseframework.inl.gov by   doxygen 1.8.14