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

Inheritance diagram for uniformInterpolationTable< Type >:

Collaboration diagram for uniformInterpolationTable< Type >:

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")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

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

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

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

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

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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 noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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)
	Read header (uses typeFilePath to find file) and check its info. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

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

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
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

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

Public Member Functions inherited from List< Type >
constexpr	List () noexcept
	Default construct. More...

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

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

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const Type &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, Type &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< Type > &a)
	Copy construct from list. More...

	List (const UList< Type > &a)
	Copy construct contents from list. More...

	List (List< Type > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< Type > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< Type > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

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

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

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

	List (const IndirectListBase< Type, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< Type > list)
	Construct from an initializer list. More...

	List (List< Type > &&list)
	Move construct from List. More...

	List (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< Type > &&list)
	Move construct from SortableList. More...

	List (SLList< Type > &&list)
	Move construct from SLList. More...

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

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

	~List ()
	Destructor. More...

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

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const Type &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

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

void	setSize (const label n, const Type &val)
	Alias for resize() More...

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

void	append (Type &&val)
	Move append an element at the end of the list. More...

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

void	append (const IndirectListBase< Type, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const Type &val)
	Append an element if not already in the list. More...

void	transfer (List< Type > &list)

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

void	transfer (SortableList< Type > &list)

Type &	newElmt (const label i)

void	operator= (const UList< Type > &a)
	Assignment to UList operator. Takes linear time. More...

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

void	operator= (const SLList< Type > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< Type, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< Type, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< Type > list)
	Assignment to an initializer list. More...

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

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< Type > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< Type, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< Type > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< Type > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< Type > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

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

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

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

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

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

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

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

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

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 72 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 54 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 83 of file uniformInterpolationTable.C.

◆ uniformInterpolationTable() [3/3]

uniformInterpolationTable ( const uniformInterpolationTable< Type > & uit )

Construct as copy.

Definition at line 122 of file uniformInterpolationTable.C.

◆ ~uniformInterpolationTable()

~uniformInterpolationTable ( )

Destructor.

Definition at line 140 of file uniformInterpolationTable.C.

Member Function Documentation

◆ x0() [1/2]

Foam::scalar x0 ( ) const

inline

Return the lower limit.

Definition at line 29 of file uniformInterpolationTableI.H.

◆ dx() [1/2]

Foam::scalar dx ( ) const

inline

Return the fixed interval.

Definition at line 36 of file uniformInterpolationTableI.H.

◆ log10() [1/2]

const Foam::Switch & log10 ( ) const

inline

Return the log10(x) flag.

Definition at line 43 of file uniformInterpolationTableI.H.

◆ bound() [1/2]

const Foam::Switch & bound ( ) const

inline

Return the bound flag.

Definition at line 50 of file uniformInterpolationTableI.H.

◆ x0() [2/2]

Foam::scalar & x0 ( )

inline

Return the lower limit.

Definition at line 57 of file uniformInterpolationTableI.H.

◆ dx() [2/2]

Foam::scalar & dx ( )

inline

Return the fixed interval.

Definition at line 64 of file uniformInterpolationTableI.H.

◆ log10() [2/2]

Foam::Switch & log10 ( )

inline

Return the log10(x) flag.

Definition at line 71 of file uniformInterpolationTableI.H.

◆ bound() [2/2]

Foam::Switch & bound ( )

inline

Return the bound flag.

Definition at line 78 of file uniformInterpolationTableI.H.

◆ xMin()

Foam::scalar xMin ( ) const

inline

Return the minimum x value.

Definition at line 85 of file uniformInterpolationTableI.H.

◆ xMax()

Foam::scalar xMax ( ) const

inline

Return the maximum x value.

Definition at line 92 of file uniformInterpolationTableI.H.

◆ interpolate()

Type interpolate ( scalar x ) const

Interpolate.

Definition at line 147 of file uniformInterpolationTable.C.

◆ interpolateLog10()

Type interpolateLog10 ( scalar x ) const

Interpolate - takes log10 flag into account.

Definition at line 192 of file uniformInterpolationTable.C.

◆ write()

void write ( ) const

Write.

Definition at line 220 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 >