Table with uniform interval in independent variable, with linear interpolation. More...

Inheritance diagram for uniformInterpolationTable< Type >:

[legend]

Collaboration diagram for uniformInterpolationTable< Type >:

Public Member Functions
	uniformInterpolationTable (const IOobject &, const bool readFields)

	uniformInterpolationTable (const word &tableName, const objectRegistry &, const dictionary &, const bool initialiseOnly=false)

	uniformInterpolationTable (const uniformInterpolationTable &)

	~uniformInterpolationTable ()

scalar	x0 () const

scalar	dx () const

const Switch &	log10 () const

const Switch &	bound () const

scalar &	x0 ()

scalar &	dx ()

Switch &	log10 ()

Switch &	bound ()

scalar	xMin () const

scalar	xMax () const

Type	interpolate (scalar x) const

Type	interpolateLog10 (scalar x) const

void	write () const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

virtual void	rename (const word &newName)

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

virtual const dictionary *	findMetaData () const noexcept

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from List< Type >
constexpr	List () noexcept

	List (const label len)

	List (const label len, const T &val)

	List (const label len, const Foam::zero)

	List (const Foam::one, const T &val)

	List (const Foam::one, T &&val)

	List (const Foam::one, const Foam::zero)

	List (const List< T > &a)

	List (const UList< T > &a)

	List (List< T > &a, bool reuse)

	List (const UList< T > &list, const labelUList &indices)

	List (const UList< T > &list, const FixedList< label, N > &indices)

	List (const FixedList< T, N > &list)

	List (const PtrList< T > &list)

	List (const SLList< T > &list)

	List (const IndirectListBase< T, Addr > &list)

	List (std::initializer_list< T > list)

	List (List< T > &&list)

	List (DynamicList< T, SizeMin > &&list)

	List (SortableList< T > &&list)

	List (SLList< T > &&list)

	List (Istream &is)

	List (const label len)

	List (const label len, const T &val)

	List (const label len, const Foam::zero)

	List (const Foam::one, const T &val)

	List (const Foam::one, T &&val)

	List (const Foam::one, const Foam::zero)

	List (const UList< T > &a)

	List (const List< T > &a)

	List (List< T > &a, bool reuse)

	List (const UList< T > &list, const labelUList &indices)

	List (const PtrList< T > &list)

	List (const SLList< T > &list)

	List (std::initializer_list< T > list)

	List (List< T > &&list)

	List (SortableList< T > &&list)

	List (SLList< T > &&list)

constexpr	List () noexcept

	List (Istream &is)

autoPtr< List< T > >	clone () const

	~List ()

void	clear ()

void	resize (const label len)

void	resize (const label len, const T &val)

void	resize (const label newLen)

void	resize_nocopy (const label len)

void	setSize (const label n)

void	setSize (const label n, const T &val)

void	append (const T &val)

void	append (T &&val)

void	append (const UList< T > &list)

void	append (const IndirectListBase< T, Addr > &list)

void	append (const T &val)

void	append (T &&val)

void	append (const UList< T > &list)

label	appendUniq (const T &val)

void	transfer (List< T > &list)

void	transfer (DynamicList< T, SizeMin > &list)

void	transfer (SortableList< T > &list)

void	transfer (List< T > &list)

void	transfer (SortableList< T > &list)

T &	newElmt (const label i)

void	operator= (const UList< T > &a)

void	operator= (const List< T > &list)

void	operator= (const SLList< T > &list)

void	operator= (const IndirectListBase< T, Addr > &list)

void	operator= (const FixedList< T, N > &list)

void	operator= (std::initializer_list< T > list)

void	operator= (const T &val)

void	operator= (const Foam::zero)

void	operator= (List< T > &&list)

void	operator= (DynamicList< T, SizeMin > &&list)

void	operator= (SortableList< T > &&list)

void	operator= (SLList< T > &&list)

void	operator= (const UList< T > &a)

void	operator= (const List< T > &list)

void	operator= (const SLList< T > &list)

void	operator= (std::initializer_list< T > list)

void	operator= (List< T > &&list)

void	operator= (SortableList< T > &&list)

void	operator= (SLList< T > &&list)

void	operator= (const T &val)

void	operator= (const Foam::zero)

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< T > &)=delete

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Public Types inherited from List< Type >
typedef SubList< T >	subList

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Member Functions inherited from List< Type >
static const List< T > &	null ()

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Detailed Description

template<class Type>
class Foam::uniformInterpolationTable< Type >

Table with uniform interval in independent variable, with linear interpolation.

Example usage (scalar): values specified within a dictionary:

{
    x0          0;          // lower limit
    dx          0.2;        // fixed interval
    log10       true;       // take log(10) when interpolating?
    data                    // list of dependent data values
    (
        7870                // value at x0
        7870                // value at x0 + dx
        ...
        7870                // value at x0 + n*dx
    );
}

Source files

Definition at line 68 of file uniformInterpolationTable.H.

Constructor & Destructor Documentation

◆ uniformInterpolationTable() [1/3]

uniformInterpolationTable	(	const IOobject &	io,
		const bool	readFields
	)

Definition at line 47 of file uniformInterpolationTable.C.

◆ uniformInterpolationTable() [2/3]

uniformInterpolationTable	(	const word &	tableName,
		const objectRegistry &	db,
		const dictionary &	dict,
		const bool	initialiseOnly = `false`
	)

Definition at line 76 of file uniformInterpolationTable.C.

◆ uniformInterpolationTable() [3/3]

uniformInterpolationTable ( const uniformInterpolationTable< Type > & uit )

Definition at line 115 of file uniformInterpolationTable.C.

◆ ~uniformInterpolationTable()

~uniformInterpolationTable

Definition at line 133 of file uniformInterpolationTable.C.

Member Function Documentation

◆ x0() [1/2]

Foam::scalar & x0

inline

Definition at line 22 of file uniformInterpolationTableI.H.

◆ dx() [1/2]

Foam::scalar & dx

inline

Definition at line 29 of file uniformInterpolationTableI.H.

◆ log10() [1/2]

Foam::Switch & log10

inline

Definition at line 36 of file uniformInterpolationTableI.H.

◆ bound() [1/2]

Foam::Switch & bound

inline

Definition at line 43 of file uniformInterpolationTableI.H.

◆ x0() [2/2]

scalar& x0 ( )

inline

◆ dx() [2/2]

scalar& dx ( )

inline

◆ log10() [2/2]

Switch& log10 ( )

inline

◆ bound() [2/2]

Switch& bound ( )

inline

◆ xMin()

Foam::scalar xMin

inline

Definition at line 78 of file uniformInterpolationTableI.H.

◆ xMax()

Foam::scalar xMax

inline

Definition at line 85 of file uniformInterpolationTableI.H.

◆ interpolate()

Type interpolate ( scalar x ) const

Definition at line 140 of file uniformInterpolationTable.C.

◆ interpolateLog10()

Type interpolateLog10 ( scalar x ) const

Definition at line 185 of file uniformInterpolationTable.C.

◆ write()

void write

Definition at line 213 of file uniformInterpolationTable.C.

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

src/OpenFOAM/interpolations/uniformInterpolationTable/uniformInterpolationTable.H
src/OpenFOAM/interpolations/uniformInterpolationTable/uniformInterpolationTable.C
src/OpenFOAM/interpolations/uniformInterpolationTable/uniformInterpolationTableI.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformInterpolationTable< Type >

Constructor & Destructor Documentation

◆ uniformInterpolationTable() [1/3]

◆ uniformInterpolationTable() [2/3]

◆ uniformInterpolationTable() [3/3]

◆ ~uniformInterpolationTable()

Member Function Documentation

◆ x0() [1/2]

◆ dx() [1/2]

◆ log10() [1/2]

◆ bound() [1/2]

◆ x0() [2/2]

◆ dx() [2/2]

◆ log10() [2/2]

◆ bound() [2/2]

◆ xMin()

◆ xMax()

◆ interpolate()

◆ interpolateLog10()

◆ write()

template<class Type>
class Foam::uniformInterpolationTable< Type >