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

Inheritance diagram for uniformInterpolationTable< Type >:

[legend]

Collaboration diagram for uniformInterpolationTable< Type >:

[legend]

Public Member Functions
	uniformInterpolationTable (const IOobject &, const bool readFields)
	Construct from IOobject and readFields flag. More...

	uniformInterpolationTable (const word &tableName, const objectRegistry &, const dictionary &, const bool initialiseOnly=false)
	Construct from name, objectRegistry and dictionary. More...

	uniformInterpolationTable (const uniformInterpolationTable &)
	Construct as copy. More...

	~uniformInterpolationTable ()
	Destructor. More...

scalar	x0 () const
	Return the lower limit. More...

scalar	dx () const
	Return the fixed interval. More...

const Switch &	log10 () const
	Return the log10(x) flag. More...

const Switch &	bound () const
	Return the bound flag. More...

scalar &	x0 ()
	Return the lower limit. More...

scalar &	dx ()
	Return the fixed interval. More...

Switch &	log10 ()
	Return the log10(x) flag. More...

Switch &	bound ()
	Return the bound flag. More...

scalar	xMin () const
	Return the minimum x value. More...

scalar	xMax () const
	Return the maximum x value. More...

Type	interpolate (scalar x) const
	Interpolate. More...

Type	interpolateLog10 (scalar x) const
	Interpolate - takes log10 flag into account. More...

void	write () const
	Write. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

Foam::autoPtr< IOobject >	clone () const
	Clone. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

virtual void	rename (const word &newName)
	Rename. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read and check header info. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from List< Type >
label	size () const
	Return the number of elements in the UList. More...

	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const T &)
	Construct with given size and value for all elements. More...

	List (const List< T > &)
	Copy constructor. More...

	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. More...

	List (List< T > &, bool reUse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< T, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< T > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< T > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< T > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< T > &)
	Construct as copy of BiIndirectList<T> More...

	List (Istream &)
	Construct from Istream. More...

	List (const label s)

	List (const label s, const T &a)

	List (const List< T > &a)

	List (const Xfer< List< T > > &lst)

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

	List (const UList< T > &a, const labelUList &map)

	List (const PtrList< T > &lst)

	List (const SLList< T > &lst)

	List (const UIndirectList< T > &lst)

	List (const BiIndirectList< T > &lst)

	List ()

	List (Istream &is)

autoPtr< List< T > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const T &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const T &)
	Append an element at the end of the list. More...

void	append (const UList< T > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< T > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< T > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (List< T > &a)

void	transfer (SortableList< T > &a)

Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...

T &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	operator= (const UList< T > &)
	Assignment from UList operator. Takes linear time. More...

void	operator= (const List< T > &)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< T > &)
	Assignment from SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< T > &)
	Assignment from UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< T > &)
	Assignment from BiIndirectList operator. Takes linear time. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

Private Member Functions
void	checkTable () const
	Check that the table is valid. More...

void	operator= (const uniformInterpolationTable &)
	Disallow default bitwise assignment. More...

Private Attributes
scalar	x0_
	Lower limit. More...

scalar	dx_
	Fixed interval. More...

Switch	log10_
	Flag to indicate that x data are given in log10(x) form. More...

Switch	bound_
	Bound x values. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

Public Types inherited from List< Type >
typedef SubList< T >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static void	replaceFileName (const word &from, const word &to)

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

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	Set the object state to bad. More...

Protected Member Functions inherited from List< Type >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

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

Table with uniform interval in independant 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 70 of file uniformInterpolationTable.H.

Constructor & Destructor Documentation

◆ uniformInterpolationTable() [1/3]

uniformInterpolationTable	(	const IOobject &	io,
		const bool	readFields
	)

Construct from IOobject and readFields flag.

Creates a null object if readFields = false

Definition at line 50 of file uniformInterpolationTable.C.

◆ uniformInterpolationTable() [2/3]

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

Construct from name, objectRegistry and dictionary.

If initialiseOnly flag is set, control parameters are read from the dictionary, but not the data table

Definition at line 79 of file uniformInterpolationTable.C.

◆ uniformInterpolationTable() [3/3]

uniformInterpolationTable ( const uniformInterpolationTable< Type > & uit )

Construct as copy.

Definition at line 118 of file uniformInterpolationTable.C.

◆ ~uniformInterpolationTable()

~uniformInterpolationTable

Destructor.

Definition at line 136 of file uniformInterpolationTable.C.

Member Function Documentation

◆ checkTable()

void checkTable

private

Check that the table is valid.

Definition at line 33 of file uniformInterpolationTable.C.

◆ operator=()

void operator= ( const uniformInterpolationTable< Type > & )

private

Disallow default bitwise assignment.

◆ x0() [1/2]

Foam::scalar & x0

inline

Return the lower limit.

Definition at line 27 of file uniformInterpolationTableI.H.

◆ dx() [1/2]

Foam::scalar & dx

inline

Return the fixed interval.

Definition at line 34 of file uniformInterpolationTableI.H.

◆ log10() [1/2]

Foam::Switch & log10

inline

Return the log10(x) flag.

Definition at line 41 of file uniformInterpolationTableI.H.

◆ bound() [1/2]

Foam::Switch & bound

inline

Return the bound flag.

Definition at line 48 of file uniformInterpolationTableI.H.

◆ x0() [2/2]

scalar& x0 ( )

inline

Return the lower limit.

◆ dx() [2/2]

scalar& dx ( )

inline

Return the fixed interval.

◆ log10() [2/2]

Switch& log10 ( )

inline

Return the log10(x) flag.

◆ bound() [2/2]

Switch& bound ( )

inline

Return the bound flag.

◆ xMin()

Foam::scalar xMin

inline

Return the minimum x value.

Definition at line 83 of file uniformInterpolationTableI.H.

◆ xMax()

Foam::scalar xMax

inline

Return the maximum x value.

Definition at line 90 of file uniformInterpolationTableI.H.

◆ interpolate()

Type interpolate ( scalar x ) const

Interpolate.

Definition at line 143 of file uniformInterpolationTable.C.

◆ interpolateLog10()

Type interpolateLog10 ( scalar x ) const

Interpolate - takes log10 flag into account.

Definition at line 188 of file uniformInterpolationTable.C.

◆ write()

void write

Write.

Definition at line 216 of file uniformInterpolationTable.C.

Field Documentation

◆ x0_

scalar x0_

private

Lower limit.

Definition at line 80 of file uniformInterpolationTable.H.

◆ dx_

scalar dx_

private

Fixed interval.

Definition at line 83 of file uniformInterpolationTable.H.

◆ log10_

Switch log10_

private

Flag to indicate that x data are given in log10(x) form.

Definition at line 86 of file uniformInterpolationTable.H.

◆ bound_

Switch bound_

private

Bound x values.

Definition at line 89 of file uniformInterpolationTable.H.

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

Private Member Functions

Private Attributes

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

◆ checkTable()

◆ operator=()

◆ 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()

Field Documentation

◆ x0_

◆ dx_

◆ log10_

◆ bound_

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