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

#include <interpolatingfunction.h>

Inheritance diagram for oofem::InterpolatingFuction:
Collaboration diagram for oofem::InterpolatingFuction:

Public Member Functions

 InterpolatingFuction (int n, Domain *d)
 Constructor.
virtual ~InterpolatingFuction ()
 Destructor.
void evaluate (FloatArray &answer, const std ::map< std ::string, FunctionArgument > &valDict, GaussPoint *gp=nullptr, double param=0.) override
double evaluateAtTime (double t) override
double evaluateVelocityAtTime (double t) override
double evaluateAccelerationAtTime (double t) override
void initializeFrom (InputRecord &ir) override
const char * giveClassName () const override
const char * giveInputRecordName () const override
Public Member Functions inherited from oofem::Function
 Function (int n, Domain *d)
virtual ~Function ()
 Destructor.
virtual double evaluate (TimeStep *tStep, ValueModeType mode)
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.
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 void giveInputRecord (DynamicInputRecord &input)
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 field
IntArray numberReal
int dimension
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 function which reads an externally generated field interpolates

Definition at line 52 of file interpolatingfunction.h.

Constructor & Destructor Documentation

◆ InterpolatingFuction()

oofem::InterpolatingFuction::InterpolatingFuction ( int n,
Domain * d )

Constructor.

Definition at line 46 of file interpolatingfunction.C.

References oofem::Function::Function().

◆ ~InterpolatingFuction()

oofem::InterpolatingFuction::~InterpolatingFuction ( )
virtual

Destructor.

Definition at line 49 of file interpolatingfunction.C.

Member Function Documentation

◆ evaluate()

void oofem::InterpolatingFuction::evaluate ( FloatArray & answer,
const std ::map< std ::string, FunctionArgument > & valDict,
GaussPoint * gp = nullptr,
double param = 0. )
overridevirtual

Returns the value of the function for given input.

Parameters
valDictMap with inputs.
answerFunction value.

Reimplemented from oofem::Function.

Definition at line 54 of file interpolatingfunction.C.

References oofem::FloatArray::at(), dimension, field, numberReal, OOFEM_ERROR, and oofem::Vec1().

◆ evaluateAccelerationAtTime()

double oofem::InterpolatingFuction::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 68 of file interpolatingfunction.h.

◆ evaluateAtTime()

double oofem::InterpolatingFuction::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 249 of file interpolatingfunction.C.

References OOFEM_ERROR.

◆ evaluateVelocityAtTime()

double oofem::InterpolatingFuction::evaluateVelocityAtTime ( double t)
inlineoverridevirtual

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

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

Implements oofem::Function.

Definition at line 67 of file interpolatingfunction.h.

◆ giveClassName()

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

Implements oofem::FEMComponent.

Definition at line 71 of file interpolatingfunction.h.

◆ giveInputRecordName()

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

Implements oofem::FEMComponent.

Definition at line 72 of file interpolatingfunction.h.

References _IFT_InterpolatingFuction_Name.

◆ initializeFrom()

void oofem::InterpolatingFuction::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 257 of file interpolatingfunction.C.

References _IFT_InterpolatingFuction_dim, _IFT_InterpolatingFuction_filename, dimension, field, IR_GIVE_FIELD, IR_GIVE_OPTIONAL_FIELD, and numberReal.

Member Data Documentation

◆ dimension

int oofem::InterpolatingFuction::dimension
protected

Definition at line 57 of file interpolatingfunction.h.

Referenced by evaluate(), and initializeFrom().

◆ field

FloatArray oofem::InterpolatingFuction::field
protected

Definition at line 55 of file interpolatingfunction.h.

Referenced by evaluate(), and initializeFrom().

◆ numberReal

IntArray oofem::InterpolatingFuction::numberReal
protected

Definition at line 56 of file interpolatingfunction.h.

Referenced by evaluate(), and initializeFrom().


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