Base class to read table data for tables. More...

Inheritance diagram for TableFileReader< Coordinate, Value >:

[legend]

Collaboration diagram for TableFileReader< Coordinate, Value >:

Public Member Functions
	TableFileReader (const Function1s::unitSets &defaultUnits, const dictionary &dict)
	Construct from dictionary. More...

	TableFileReader (const TableFileReader< Coordinate, Value > &)
	Copy construct. More...

virtual	~TableFileReader ()
	Destructor. More...

virtual List< Tuple2< Coordinate, Value > >	read (const Function1s::unitSets &units, const dictionary &dict, const word &valuesKeyword=word::null) const
	Read values. More...

virtual void	write (Ostream &os, const Function1s::unitSets &units, const List< Tuple2< Coordinate, Value >> &table, const word &valuesKeyword=word::null) const
	Write additional information. More...

Public Member Functions inherited from TableReader< Coordinate, Value >
	TypeName ("TableReader")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, TableReader, dictionary,(const word &name, const Function1s::unitSets &units, const dictionary &dict),(name, units, dict))

	TableReader ()
	Default construct. More...

virtual autoPtr< TableReader< Coordinate, Value > >	clone () const =0
	Construct and return a clone. More...

virtual	~TableReader ()
	Destructor. More...

Protected Member Functions
void	read (const Function1s::unitSets &defaultUnits, const dictionary &dict, List< Tuple2< Coordinate, Value >> &) const
	Read a 1D table. More...

Protected Member Functions inherited from TableReader< Coordinate, Value >
void	convertRead (const Function1s::unitSets &units, List< Tuple2< Coordinate, Value >> &table) const
	Do unit conversions on input data. More...

List< Tuple2< Coordinate, Value > >	convertRead (const Function1s::unitSets &units, const List< Tuple2< Coordinate, Value >> &table) const
	Do unit conversions on input data. More...

List< Tuple2< Coordinate, Value > >	convertWrite (const Function1s::unitSets &units, const List< Tuple2< Coordinate, Value >> &table) const
	Do unit conversions in order to output data. More...

Additional Inherited Members
Static Public Member Functions inherited from TableReader< Coordinate, Value >
static autoPtr< TableReader< Coordinate, Value > >	New (const word &name, const Function1s::unitSets &units, const dictionary &dict)

Detailed Description

template<class Coordinate, class Value>
class Foam::TableFileReader< Coordinate, Value >

Base class to read table data for tables.

Source files

Definition at line 49 of file TableFileReader.H.

Constructor & Destructor Documentation

◆ TableFileReader() [1/2]

TableFileReader	(	const Function1s::unitSets &	defaultUnits,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 101 of file TableFileReader.C.

◆ TableFileReader() [2/2]

TableFileReader ( const TableFileReader< Coordinate, Value > & tfr )

Copy construct.

Definition at line 114 of file TableFileReader.C.

◆ ~TableFileReader()

~TableFileReader

virtual

Destructor.

Definition at line 133 of file TableFileReader.C.

Member Function Documentation

◆ read() [1/2]

void read	(	const Function1s::unitSets &	defaultUnits,
		const dictionary &	dict,
		List< Tuple2< Coordinate, Value >> &	table
	)		const

protected

Read a 1D table.

Definition at line 57 of file TableFileReader.C.

References Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileHandler(), Istream::good(), Foam::nl, Foam::blockMeshTools::read(), Foam::dimensions::table, and Foam::unitsPtr_().

Here is the call graph for this function:

◆ read() [2/2]

Foam::List< Foam::Tuple2< Coordinate, Value > > read	(	const Function1s::unitSets &	units,
		const dictionary &	dict,
		const word &	valuesKeyword = `word::null`
	)		const

virtual

Read values.

Implements TableReader< Coordinate, Value >.

Definition at line 141 of file TableFileReader.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ write()

void write	(	Ostream &	os,
		const Function1s::unitSets &	units,
		const List< Tuple2< Coordinate, Value >> &	table,
		const word &	valuesKeyword = `word::null`
	)		const

virtual

Write additional information.

Implements TableReader< Coordinate, Value >.

Reimplemented in Foam< Coordinate, Value >, and Csv< Coordinate, Value >.

Definition at line 155 of file TableFileReader.C.

References Foam::type(), Foam::unitsPtr_(), and Foam::writeEntry().

Referenced by Csv< Coordinate, Value >::write(), and Foam< Coordinate, Value >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/Table/TableReader/TableFileReader/TableFileReader.H
src/OpenFOAM/primitives/functions/Function1/Table/TableReader/TableFileReader/TableFileReader.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class Coordinate, class Value> class Foam::TableFileReader< Coordinate, Value >

Constructor & Destructor Documentation

◆ TableFileReader() [1/2]

◆ TableFileReader() [2/2]

◆ ~TableFileReader()

Member Function Documentation

◆ read() [1/2]

◆ read() [2/2]

◆ write()

template<class Coordinate, class Value>
class Foam::TableFileReader< Coordinate, Value >