OOFEM 3.0
Loading...
Searching...
No Matches
oofem::PiecewiseLinFunction Class Reference

#include <piecewiselinfunction.h>

Inheritance diagram for oofem::PiecewiseLinFunction:
Collaboration diagram for oofem::PiecewiseLinFunction:

Public Member Functions

 PiecewiseLinFunction (int i, Domain *d)
virtual ~PiecewiseLinFunction ()
void initializeFrom (InputRecord &ir) override
void giveInputRecord (DynamicInputRecord &input) override
const char * giveClassName () const override
const char * giveInputRecordName () const override
void saveContext (DataStream &stream, ContextMode mode) override
void restoreContext (DataStream &stream, ContextMode mode) override
double evaluateAtTime (double t) 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)
Public Member Functions inherited from oofem::FEMComponent
 FEMComponent (int n, Domain *d)
virtual ~FEMComponent ()=default
 Virtual destructor.
DomaingiveDomain () 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 InterfacegiveInterface (InterfaceType t)
std::string errorInfo (const char *func) const
 Returns string for prepending output (used by error reporting macros).

Protected Attributes

FloatArray dates
FloatArray values
Protected Attributes inherited from oofem::FEMComponent
int number
 Component number.
Domaindomain
 Link to domain object, useful for communicating with other FEM components.

Additional Inherited Members

Public Attributes inherited from oofem::Function
DomainfuncDomain
int parameterType

Detailed Description

This class implements a piecewise linear function. The function is defined by 'numberOfPoints' points. 'dates' and 'values' store respectively the abscissas (t) and the values (f(t)) of the points

Definition at line 55 of file piecewiselinfunction.h.

Constructor & Destructor Documentation

◆ PiecewiseLinFunction()

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

◆ ~PiecewiseLinFunction()

virtual oofem::PiecewiseLinFunction::~PiecewiseLinFunction ( )
inlinevirtual

Definition at line 63 of file piecewiselinfunction.h.

Member Function Documentation

◆ evaluateAccelerationAtTime()

double oofem::PiecewiseLinFunction::evaluateAccelerationAtTime ( double t)
inlineoverridevirtual

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

Parameters
tTime.
Returns
\( f''(t) \).

Implements oofem::Function.

Definition at line 75 of file piecewiselinfunction.h.

◆ evaluateAtTime()

double oofem::PiecewiseLinFunction::evaluateAtTime ( double t)
overridevirtual

Returns the value of the function at given time.

Parameters
tTime.
Returns
\( f(t) \).

Reimplemented from oofem::Function.

Definition at line 51 of file piecewiselinfunction.C.

References dates, OOFEM_ERROR, OOFEM_WARNING, PiecewiseLinFunction_PRECISION, and values.

◆ evaluateVelocityAtTime()

double oofem::PiecewiseLinFunction::evaluateVelocityAtTime ( double t)
overridevirtual

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

Parameters
tTime.
Returns
\( f'(t) \).

Implements oofem::Function.

Definition at line 85 of file piecewiselinfunction.C.

References dates, OOFEM_ERROR, PiecewiseLinFunction_PRECISION, and values.

◆ giveClassName()

const char * oofem::PiecewiseLinFunction::giveClassName ( ) const
inlineoverridevirtual
Returns
Class name of the receiver.

Implements oofem::FEMComponent.

Definition at line 67 of file piecewiselinfunction.h.

◆ giveInputRecord()

void oofem::PiecewiseLinFunction::giveInputRecord ( DynamicInputRecord & input)
overridevirtual

Setups the input record string of receiver.

Parameters
inputDynamic input record to be filled by receiver.

Reimplemented from oofem::FEMComponent.

Definition at line 170 of file piecewiselinfunction.C.

References _IFT_PiecewiseLinFunction_ft, _IFT_PiecewiseLinFunction_t, dates, oofem::DynamicInputRecord::setField(), and values.

◆ giveInputRecordName()

const char * oofem::PiecewiseLinFunction::giveInputRecordName ( ) const
inlineoverridevirtual
Returns
Input record name of the receiver.

Implements oofem::FEMComponent.

Definition at line 68 of file piecewiselinfunction.h.

References _IFT_PiecewiseLinFunction_Name.

◆ initializeFrom()

void oofem::PiecewiseLinFunction::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
irInput record to initialize from.
priorityPriority of the input record. This is used to determine the order of initialization

Reimplemented from oofem::FEMComponent.

Definition at line 122 of file piecewiselinfunction.C.

References _IFT_PiecewiseLinFunction_dataFile, _IFT_PiecewiseLinFunction_ft, _IFT_PiecewiseLinFunction_t, dates, oofem::InputRecord::hasField(), IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, OOFEM_ERROR, oofem::Function::parameterType, and values.

◆ restoreContext()

void oofem::PiecewiseLinFunction::restoreContext ( DataStream & stream,
ContextMode mode )
overridevirtual

Restores the receiver state previously written in stream.

See also
saveContext
Parameters
streamInput stream.
modeDetermines amount of info available in stream (state, definition, ...).
Exceptions
throwsan ContextIOERR exception if error encountered.

Reimplemented from oofem::Function.

Definition at line 190 of file piecewiselinfunction.C.

References CM_Definition, dates, and values.

◆ saveContext()

void oofem::PiecewiseLinFunction::saveContext ( DataStream & stream,
ContextMode mode )
overridevirtual

Stores receiver state to output stream.

Parameters
streamOutput stream.
modeDetermines amount of info required in stream (state, definition, ...).
Exceptions
throwsan ContextIOERR exception if error encountered.

Reimplemented from oofem::Function.

Definition at line 180 of file piecewiselinfunction.C.

References CM_Definition, dates, and values.

Member Data Documentation

◆ dates

◆ values

FloatArray oofem::PiecewiseLinFunction::values
protected

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

This page is part of the OOFEM-3.0 documentation. Copyright Copyright (C) 1994-2025 Borek Patzak Bořek Patzák
Project e-mail: oofem@fsv.cvut.cz
Generated at for OOFEM by doxygen 1.15.0 written by Dimitri van Heesch, © 1997-2011