www.mooseframework.org
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 ()
 

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 30 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
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:360
int & _t_step
The number of the time step.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:57
const InputParameters & _ti_params
virtual int & timeStep() const
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

◆ isImplicit()

bool TransientInterface::isImplicit ( )
inline

Definition at line 36 of file TransientInterface.h.

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

Member Data Documentation

◆ _dt

Real& TransientInterface::_dt
protected

Time step size.

Definition at line 58 of file TransientInterface.h.

Referenced by TotalVariableValue::execute(), and VariableTimeIntegrationAux::getIntegralValue().

◆ _dt_old

Real& TransientInterface::_dt_old
protected

Size of the old time step.

Definition at line 61 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 49 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient
protected

Definition at line 64 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _t

Real& TransientInterface::_t
protected

◆ _t_step

int& TransientInterface::_t_step
protected

The number of the time step.

Definition at line 55 of file TransientInterface.h.

Referenced by ChangeOverTimePostprocessor::getValue().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem
protected

Definition at line 41 of file TransientInterface.h.

Referenced by SolutionFunction::SolutionFunction().

◆ _ti_name

const std::string TransientInterface::_ti_name
private

Definition at line 67 of file TransientInterface.h.

◆ _ti_params

const InputParameters& TransientInterface::_ti_params
protected

Definition at line 39 of file TransientInterface.h.


The documentation for this class was generated from the following files: