oofem::HeavisideTimeFunction Class Reference

#include <heavisidetimefunction.h>

Inheritance diagram for oofem::HeavisideTimeFunction:

Collaboration diagram for oofem::HeavisideTimeFunction:

Public Member Functions
	HeavisideTimeFunction (int i, Domain *d)
virtual	~HeavisideTimeFunction ()
void	initializeFrom (InputRecord &ir) override
void	giveInputRecord (DynamicInputRecord &input) override
const char *	giveClassName () const override
const char *	giveInputRecordName () const override
double	evaluateAtTime (double) override
double	evaluateVelocityAtTime (double t) override
double	evaluateAccelerationAtTime (double t) override
Public Member Functions inherited from oofem::Function
	Function (int n, Domain *d)
virtual	~Function ()
	Destructor.
virtual double	evaluate (TimeStep *tStep, ValueModeType mode)
virtual void	evaluate (FloatArray &answer, const std ::map< std ::string, FunctionArgument > &valDict, GaussPoint *gp=nullptr, double param=0.)
virtual double	evaluate (const std ::map< std ::string, FunctionArgument > &valDict)
double	giveFunctionParameter (int paramID)
void	saveContext (DataStream &stream, ContextMode mode) override
void	restoreContext (DataStream &stream, ContextMode mode) override
Public Member Functions inherited from oofem::FEMComponent
	FEMComponent (int n, Domain *d)
virtual	~FEMComponent ()=default
	Virtual destructor.
Domain *	giveDomain () const
virtual void	setDomain (Domain *d)
int	giveNumber () const
void	setNumber (int num)
virtual void	updateLocalNumbering (EntityRenumberingFunctor &f)
virtual void	initializeFrom (InputRecord &ir, int priority)
virtual void	initializeFinish ()
virtual void	postInitialize ()
	Performs post initialization steps. Called after all components are created and initialized.
virtual int	checkConsistency ()
virtual void	printOutputAt (FILE *file, TimeStep *tStep)
virtual void	printYourself ()
	Prints receiver state on stdout. Useful for debugging.
virtual Interface *	giveInterface (InterfaceType t)
std::string	errorInfo (const char *func) const
	Returns string for prepending output (used by error reporting macros).

Private Attributes
double	origin
double	value

Additional Inherited Members
Public Attributes inherited from oofem::Function
Domain *	funcDomain
int	parameterType
Protected Attributes inherited from oofem::FEMComponent
int	number
	Component number.
Domain *	domain
	Link to domain object, useful for communicating with other FEM components.

Detailed Description

This class implements a Heaviside step load time function.

The function is defined by the origin of step and value. The result is value*H(t-origin), where

\[H(t) = \begin{cases} 0,& t\leq 0 \\ 1, & t>0 \end{cases} \]

Definition at line 59 of file heavisidetimefunction.h.

Constructor & Destructor Documentation

HeavisideTimeFunction()

oofem::HeavisideTimeFunction::HeavisideTimeFunction ( int i, Domain * d )

inline

Definition at line 65 of file heavisidetimefunction.h.

References oofem::Function::Function(), origin, and value.

~HeavisideTimeFunction()

virtual oofem::HeavisideTimeFunction::~HeavisideTimeFunction ( )

inlinevirtual

Definition at line 69 of file heavisidetimefunction.h.

Member Function Documentation

evaluateAccelerationAtTime()

double oofem::HeavisideTimeFunction::evaluateAccelerationAtTime ( double t )

inlineoverridevirtual

Returns the second time derivative of the function at given time.

Parameters

t

Time.

Returns

\( f''(t) \).

Implements oofem::Function.

Definition at line 78 of file heavisidetimefunction.h.

evaluateAtTime()

double oofem::HeavisideTimeFunction::evaluateAtTime ( double t )

overridevirtual

Returns the value of the function at given time.

Parameters

t

Time.

Returns

\( f(t) \).

Reimplemented from oofem::Function.

Definition at line 43 of file heavisidetimefunction.C.

References origin, and value.

evaluateVelocityAtTime()

double oofem::HeavisideTimeFunction::evaluateVelocityAtTime ( double t )

inlineoverridevirtual

Returns the first time derivative of the function at given time.

Parameters

t

Time.

Returns

\( f'(t) \).

Implements oofem::Function.

Definition at line 77 of file heavisidetimefunction.h.

giveClassName()

const char * oofem::HeavisideTimeFunction::giveClassName ( ) const

inlineoverridevirtual

Returns

Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 73 of file heavisidetimefunction.h.

giveInputRecord()

void oofem::HeavisideTimeFunction::giveInputRecord ( DynamicInputRecord & input )

overridevirtual

Setups the input record string of receiver.

Parameters

input

Dynamic input record to be filled by receiver.

Reimplemented from oofem::FEMComponent.

Definition at line 64 of file heavisidetimefunction.C.

References _IFT_HeavisideTimeFunction_origin, _IFT_HeavisideTimeFunction_value, origin, oofem::DynamicInputRecord::setField(), and value.

giveInputRecordName()

const char * oofem::HeavisideTimeFunction::giveInputRecordName ( ) const

inlineoverridevirtual

Returns

Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 74 of file heavisidetimefunction.h.

References _IFT_HeavisideTimeFunction_Name.

initializeFrom()

void oofem::HeavisideTimeFunction::initializeFrom ( InputRecord & ir )

overridevirtual

Initializes receiver according to object description stored in input record. This function is called immediately after creating object using constructor. Input record can be imagined as data record in component database belonging to receiver. Receiver may use value-name extracting functions to extract particular field from record. Note that initializeFrom may be called mutiple times.

See also

IR_GIVE_FIELD

IR_GIVE_OPTIONAL_FIELD

Parameters

ir	Input record to initialize from.
priority	Priority of the input record. This is used to determine the order of initialization

Reimplemented from oofem::FEMComponent.

Definition at line 55 of file heavisidetimefunction.C.

References _IFT_HeavisideTimeFunction_origin, _IFT_HeavisideTimeFunction_value, IR_GIVE_FIELD, origin, and value.

Member Data Documentation

origin

double oofem::HeavisideTimeFunction::origin

private

Definition at line 62 of file heavisidetimefunction.h.

Referenced by evaluateAtTime(), giveInputRecord(), HeavisideTimeFunction(), and initializeFrom().

value

double oofem::HeavisideTimeFunction::value

private

Definition at line 62 of file heavisidetimefunction.h.

Referenced by evaluateAtTime(), giveInputRecord(), HeavisideTimeFunction(), and initializeFrom().

---

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

• heavisidetimefunction.h
• heavisidetimefunction.C