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

Constructor & Destructor Documentation

TransientInterface::TransientInterface ( const MooseObject moose_object)

Definition at line 32 of file TransientInterface.C.

33  : _ti_params(moose_object->parameters()),
34  _ti_feproblem(*_ti_params.get<FEProblemBase *>("_fe_problem_base")),
35  _is_implicit(_ti_params.have_parameter<bool>("implicit") ? _ti_params.get<bool>("implicit")
36  : true),
39  _dt(_ti_feproblem.dt()),
42  _ti_name(MooseUtils::shortName(_ti_params.get<std::string>("_object_name")))
43 {
44 }
virtual Real & timeOld() const
FEProblemBase & _ti_feproblem
Real & _dt_old
Size of the old time step.
virtual Real & time() const
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:325
int & _t_step
The number of the time step.
virtual int & timeStep() const
const InputParameters & _ti_params
virtual bool isTransient() const override
virtual Real & dt() const
virtual Real & dtOld() const
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
const std::string _ti_name
bool _is_implicit
If the object is using implicit or explicit form.
TransientInterface::~TransientInterface ( )
virtual

Definition at line 46 of file TransientInterface.C.

46 {}

Member Function Documentation

bool TransientInterface::isImplicit ( )
inline

Definition at line 41 of file TransientInterface.h.

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

Member Data Documentation

Real& TransientInterface::_dt
protected

Time step size.

Definition at line 63 of file TransientInterface.h.

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

Real& TransientInterface::_dt_old
protected

Size of the old time step.

Definition at line 66 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

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

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

bool TransientInterface::_is_transient
protected

Definition at line 69 of file TransientInterface.h.

Real& TransientInterface::_t
protected
int& TransientInterface::_t_step
protected

The number of the time step.

Definition at line 60 of file TransientInterface.h.

FEProblemBase& TransientInterface::_ti_feproblem
protected

Definition at line 46 of file TransientInterface.h.

Referenced by SolutionFunction::SolutionFunction().

const std::string TransientInterface::_ti_name
private

Definition at line 72 of file TransientInterface.h.

const InputParameters& TransientInterface::_ti_params
protected

Definition at line 44 of file TransientInterface.h.


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