www.mooseframework.org
Public Member Functions | Static Public Member Functions | Protected 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 ()
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

Moose::StateArg determineState () const
 Create a functor state argument that corresponds to the implicit state of this object. More...
 

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...
 
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()),
30  _is_implicit(_ti_params.have_parameter<bool>("implicit") ? _ti_params.get<bool>("implicit")
31  : true),
34  _dt(_ti_feproblem.dt()),
37  _ti_name(MooseUtils::shortName(_ti_params.get<std::string>("_object_name")))
38 {
39 }
virtual Real & dtOld() const
virtual Real & time() const
FEProblemBase & _ti_feproblem
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.
Real & _dt_old
Size of the old time step.
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...
Real & _dt
Time step size.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
std::string shortName(const std::string &name)
Function for stripping name after the file / in parser block.
Definition: MooseUtils.C:595
int & _t_step
The number of the time step.
const InputParameters & _ti_params
virtual int & timeStep() const
bool have_parameter(std::string_view name) const
A wrapper around the Parameters base class method.
const InputParameters & parameters() const
Get the parameters of the object.
virtual Real & timeOld() const
virtual bool isTransient() const override
const std::string _ti_name
virtual Real & dt() const
bool _is_implicit
If the object is using implicit or explicit form.

◆ ~TransientInterface()

TransientInterface::~TransientInterface ( )
virtual

Definition at line 41 of file TransientInterface.C.

41 {}

Member Function Documentation

◆ determineState()

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

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 80 of file TransientInterface.h.

Referenced by SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), LayeredSideDiffusiveFluxAverage::computeQpIntegral(), SideIntegralFunctorUserObject::computeQpIntegral(), SideIntegralVariableUserObject::computeQpIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), FVTwoVarContinuityConstraint::computeQpResidual(), FVDiffusionInterface::computeQpResidual(), FVOneVarDiffusionInterface::computeQpResidual(), FVFunctorTimeKernel::computeQpResidual(), FVMatAdvection::computeQpResidual(), FVAdvection::computeQpResidual(), FVConstantScalarOutflowBC::computeQpResidual(), FVAnisotropicDiffusion::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVFunctorNeumannBC::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVDivergence::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), FVDiffusion::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), AdvectiveFluxAux::computeValue(), TimeDerivativeAux::computeValue(), SecondTimeDerivativeAux::computeValue(), FunctorAux::computeValue(), PositionsFunctorValueSampler::execute(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), FunctorPositions::initialize(), and FunctorTimes::initialize().

81 {
83 }
StateArg oldState()
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
StateArg currentState()
bool _is_implicit
If the object is using implicit or explicit form.

◆ isImplicit()

bool TransientInterface::isImplicit ( )
inline

Definition at line 38 of file TransientInterface.h.

Referenced by ComputeJacobianThread::compute().

38 { return _is_implicit; }
bool _is_implicit
If the object is using implicit or explicit form.

◆ validParams()

InputParameters TransientInterface::validParams ( )
static

Definition at line 14 of file TransientInterface.C.

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

15 {
16 
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 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
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...

Member Data Documentation

◆ _dt

Real& TransientInterface::_dt
protected

◆ _dt_old

Real& TransientInterface::_dt_old
protected

Size of the old time step.

Definition at line 70 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 73 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(), ElementH1SemiError::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementW1pError::computeQpIntegral(), FunctionDiffusion::computeQpJacobian(), VectorFunctionReaction::computeQpJacobian(), ArrayBodyForce::computeQpResidual(), FunctionDiffusion::computeQpResidual(), ConvectiveFluxBC::computeQpResidual(), ADFunctionNeumannBC::computeQpResidual(), ADVectorFunctionNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), FVFunctionNeumannBC::computeQpResidual(), FunctionGradientNeumannBC::computeQpResidual(), FunctionNeumannBC::computeQpResidual(), VectorFunctionReaction::computeQpResidual(), VectorCurlPenaltyDirichletBC::computeQpResidual(), VectorDivPenaltyDirichletBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), VectorPenaltyDirichletBC::computeQpResidual(), ADConservativeAdvectionBC::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), FVBodyForce::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), SinDirichletBC::computeQpResidual(), ADFunctionPenaltyDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), ADFunctionDirichletBC::computeQpValue(), ADVectorFunctionDirichletBC::computeQpValue(), FunctionDirichletBC::computeQpValue(), FunctionArrayAux::computeValue(), ForcingFunctionAux::computeValue(), ParsedAux::computeValue(), ParsedVectorAux::computeValue(), ArrayParsedAux::computeValue(), FunctionScalarAux::computeValue(), VectorFunctionAux::computeValue(), FunctionAux::computeValue(), SolutionScalarAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), ConditionalFunctionEnableControl::conditionMet(), TimePeriod::conditionMet(), IterationInfo::execute(), LineFunctionSampler::execute(), NodalL2Error::execute(), BoolFunctionControl::execute(), PIDTransientControl::execute(), RealFunctionControl::execute(), LeastSquaresFitHistory::execute(), TimeExtremeValue::execute(), UserForcingFunction::f(), ParsedPostprocessor::finalize(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), ActivateElementsByPath::isElementActivated(), and SolutionUserObject::timestepSetup().

◆ _t_step

int& TransientInterface::_t_step
protected

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem
protected

◆ _ti_name

const std::string TransientInterface::_ti_name
private

Definition at line 76 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: