Flow123d  master-1fea4ce
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
TableFunction< Value > Class Template Reference

#include <table_function.hh>

Collaboration diagram for TableFunction< Value >:
Collaboration graph
[legend]

Classes

struct  TableValue
 Store value in one t stamp. More...
 

Public Types

typedef Value::return_type return_type
 

Public Member Functions

 TableFunction ()
 Default constructor. More...
 
void init_from_input (const Input::Record &rec, const TimeStep &time)
 Initialize actual values of the field given from the given Input::Record rec. More...
 
bool initialized ()
 Return true if TableFunction is initialized (method init_from_input was called). More...
 
return_type const & value (double t)
 

Static Public Member Functions

static const Input::Type::Tupleget_input_type_val ()
 
static const Input::Type::Recordget_input_type ()
 

Private Member Functions

void interpolated (double coef, unsigned int idx)
 

Private Attributes

std::vector< struct TableValuetable_values_
 Vector of values in all stamps. More...
 
double last_t_
 Last t stamp of computed value_ (to prevent repetitive calculation) More...
 
Value value_
 Last value, prevents passing large values (vectors) by value. More...
 
return_type r_value_
 

Detailed Description

template<class Value>
class TableFunction< Value >

Definition at line 38 of file table_function.hh.

Member Typedef Documentation

◆ return_type

template<class Value >
typedef Value::return_type TableFunction< Value >::return_type

Definition at line 41 of file table_function.hh.

Constructor & Destructor Documentation

◆ TableFunction()

template<class Value >
TableFunction< Value >::TableFunction

Default constructor.

Definition at line 57 of file table_function.cc.

Member Function Documentation

◆ get_input_type()

template<class Value >
const it::Record & TableFunction< Value >::get_input_type
static

Return Record for one t stamp series initialization of Fields. Allow to use interpolation of Field values defined in one field descriptor.

Definition at line 45 of file table_function.cc.

◆ get_input_type_val()

template<class Value >
const it::Tuple & TableFunction< Value >::get_input_type_val
static

Return record of one t stamp.

Definition at line 27 of file table_function.cc.

◆ init_from_input()

template<class Value >
void TableFunction< Value >::init_from_input ( const Input::Record rec,
const TimeStep time 
)

Initialize actual values of the field given from the given Input::Record rec.

Definition at line 64 of file table_function.cc.

Here is the caller graph for this function:

◆ initialized()

template<class Value >
bool TableFunction< Value >::initialized

Return true if TableFunction is initialized (method init_from_input was called).

Definition at line 87 of file table_function.cc.

◆ interpolated()

template<class Value >
void TableFunction< Value >::interpolated ( double  coef,
unsigned int  idx 
)
private

Definition at line 122 of file table_function.cc.

◆ value()

template<class Value >
TableFunction< Value >::return_type const & TableFunction< Value >::value ( double  t)

Returns one value in one given point. ResultType can be used to avoid some costly calculation if the result is trivial.

Definition at line 93 of file table_function.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ last_t_

template<class Value >
double TableFunction< Value >::last_t_
private

Last t stamp of computed value_ (to prevent repetitive calculation)

Definition at line 86 of file table_function.hh.

◆ r_value_

template<class Value >
return_type TableFunction< Value >::r_value_
private

Definition at line 90 of file table_function.hh.

◆ table_values_

template<class Value >
std::vector<struct TableValue> TableFunction< Value >::table_values_
private

Vector of values in all stamps.

Definition at line 83 of file table_function.hh.

◆ value_

template<class Value >
Value TableFunction< Value >::value_
private

Last value, prevents passing large values (vectors) by value.

Definition at line 89 of file table_function.hh.


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