TransientInterface Class Reference

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

#include <TransientInterface.h>

Inheritance diagram for TransientInterface:

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

Constructor & Destructor Documentation

TransientInterface()

TransientInterface::TransientInterface

(

const MooseObject *

moose_object

)

Definition at line 27 of file TransientInterface.C.

  : _ti_params(moose_object->parameters()),
    _ti_feproblem(*_ti_params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _is_implicit(_ti_params.have_parameter<bool>("implicit") ? _ti_params.get<bool>("implicit")
                                                             : true),
    _t(_is_implicit ? _ti_feproblem.time() : _ti_feproblem.timeOld()),
    _t_step(_ti_feproblem.timeStep()),
    _dt(_ti_feproblem.dt()),
    _dt_old(_ti_feproblem.dtOld()),
    _is_transient(_ti_feproblem.isTransient()),
    _ti_name(MooseUtils::shortName(_ti_params.get<std::string>("_object_name")))
{
}

~TransientInterface()

TransientInterface::~TransientInterface ( )

virtual

Definition at line 41 of file TransientInterface.C.

{}

Member Function Documentation

isImplicit()

bool TransientInterface::isImplicit ( )

inline

Definition at line 42 of file TransientInterface.h.

{ return _is_implicit; }

Member Data Documentation

_dt

Real& TransientInterface::_dt

protected

Time step size.

Definition at line 64 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 67 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 55 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 70 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

_t

Real& TransientInterface::_t

protected

Time.

Definition at line 58 of file TransientInterface.h.

Referenced by GenericFunctionMaterial::computeQpFunctions(), AnalyticalIndicator::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementL2Error::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), FunctionNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), ConvectiveFluxBC::computeQpResidual(), LagrangeVecFunctionDirichletBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), BodyForce::computeQpResidual(), SinDirichletBC::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), FunctionPresetBC::computeQpValue(), FunctionScalarAux::computeValue(), FunctionAux::computeValue(), VectorFunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), LineFunctionSampler::execute(), NodalL2Error::execute(), RealFunctionControl::execute(), TimePeriod::execute(), LeastSquaresFitHistory::execute(), UserForcingFunction::f(), FunctionDirichletBC::f(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), and SolutionUserObject::timestepSetup().

_t_step

int& TransientInterface::_t_step

protected

The number of the time step.

Definition at line 61 of file TransientInterface.h.

Referenced by ChangeOverTimePostprocessor::getValue().

_ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem

protected

Definition at line 47 of file TransientInterface.h.

Referenced by SolutionFunction::SolutionFunction().

_ti_name

const std::string TransientInterface::_ti_name

private

Definition at line 73 of file TransientInterface.h.

_ti_params

const InputParameters& TransientInterface::_ti_params

protected

Definition at line 45 of file TransientInterface.h.

---

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

• include/interfaces/TransientInterface.h
• src/interfaces/TransientInterface.C