Templated CSV function. More...

Inheritance diagram for CSV< Type >:

Collaboration diagram for CSV< Type >:

Public Member Functions
	TypeName ("csvFile")
	Declare type-name, virtual type (with debug switch) More...

	CSV (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const fileName &fName=fileName::null)
	Construct from entry name, dictionary and optional registry. More...

	CSV (const CSV< Type > &csv)
	Copy construct. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

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

virtual const fileName &	fName () const
	Return const access to the file name. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from TableBase< Type >
	TableBase (const word &name, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from dictionary - note table is not populated. More...

	TableBase (const TableBase< Type > &tbl)
	Copy constructor. Note: steals interpolator, tableSamples. More...

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

void	initialise ()
	Check the table for size and consistency. More...

bool	checkMinBounds (const scalar x, scalar &xDash) const
	Check minimum table bounds. More...

bool	checkMaxBounds (const scalar x, scalar &xDash) const
	Check maximum table bounds. More...

virtual void	userTimeToTime (const Time &t)
	Convert time. More...

virtual Type	value (const scalar x) const
	Return Table value. More...

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...

virtual tmp< scalarField >	x () const
	Return the reference values. More...

virtual tmp< Field< Type > >	y () const
	Return the dependent values. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry. More...

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

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

virtual bool	constant () const
	Is value constant (i.e. independent of x) More...

virtual bool	good () const
	Can function be evaluated? More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable. More...

virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...

Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry. More...

	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry. More...

	function1Base (const function1Base &rhs)
	Copy construct. More...

virtual	~function1Base ()
	Destructor. More...

const word &	name () const noexcept
	The name of the entry. More...

const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr. More...

void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry. More...

void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry. More...

const objectRegistry &	obr () const
	Return the object registry. More...

bool	isTime () const noexcept
	Return true if this function was created with the time database. More...

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

template<class MeshType >
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char , int >> compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector with external storage of Function1. This also allows wildcard matches in a dictionary. More...

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from TableBase< Type >
const interpolationWeights &	interpolator () const
	Return (demand driven) interpolator. More...

void	operator= (const TableBase< Type > &)=delete
	No copy assignment. More...

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment. More...

Protected Attributes inherited from TableBase< Type >
const bounds::repeatableBounding	bounding_
	Handling for out-of-bound values. More...

const word	interpolationScheme_
	Interpolation type. More...

List< Tuple2< scalar, Type > >	table_
	Table data. More...

autoPtr< scalarField >	tableSamplesPtr_
	Extracted values. More...

autoPtr< interpolationWeights >	interpolatorPtr_
	Interpolator method. More...

labelList	currentIndices_
	Cached indices and weights. More...

scalarField	currentWeights_

Protected Attributes inherited from function1Base
const word	name_
	Name of entry. More...

const objectRegistry *	obrPtr_
	Pointer to an object registry. More...

Detailed Description

template<class Type>
class Foam::Function1Types::CSV< Type >

Templated CSV function.

Reference column is always a scalar, e.g. time.

Usage:

    <entryName> csvFile;
    <entryName>Coeffs
    {
        nHeaderLine         4;          // number of header lines
        refColumn           0;          // reference column index
        componentColumns    (1 2 3);    // component column indices
        separator           ",";        // optional (defaults to ",")
        mergeSeparators     no;         // merge multiple separators
        file                "fileXYZ";  // name of csv data file
        outOfBounds         clamp;      // optional out-of-bounds handling
        interpolationScheme linear;     // optional interpolation scheme
    }

Source files

CSV.H
CSV.C

Definition at line 71 of file CSV.H.

Constructor & Destructor Documentation

◆ CSV() [1/2]

CSV	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`,
		const fileName &	fName = `fileName::null`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 203 of file CSV.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ CSV() [2/2]

CSV ( const CSV< Type > & csv )

explicit

Copy construct.

Definition at line 225 of file CSV.C.

◆ ~CSV()

virtual ~CSV ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "csvFile" )

Declare type-name, virtual type (with debug switch)

◆ clone()

virtual tmp<Function1<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 164 of file CSV.H.

◆ fName()

const Foam::fileName & fName ( ) const

virtual

Return const access to the file name.

Definition at line 240 of file CSV.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 268 of file CSV.C.

References Foam::name(), os(), and Function1< Type >::writeData().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream & os ) const

virtual

Write coefficient entries in dictionary format.

Reimplemented from TableBase< Type >.

Definition at line 247 of file CSV.C.

References IOstreamOption::ASCII, os(), and TableBase< Type >::writeEntries().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/CSV/CSV.H
src/OpenFOAM/primitives/functions/Function1/CSV/CSV.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::Function1Types::CSV< Type >

Constructor & Destructor Documentation

◆ CSV() [1/2]

◆ CSV() [2/2]

◆ ~CSV()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ fName()

◆ writeData()

◆ writeEntries()

template<class Type>
class Foam::Function1Types::CSV< Type >