Inheritance diagram for Sample< Type >:

Collaboration diagram for Sample< Type >:

Public Member Functions
	TypeName ("sample")
	Runtime type information. More...

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

	Sample (const word &entryName, const List< Tuple2< Type, Type >> &coeffs, const objectRegistry *obrPtr=nullptr)
	Construct from components. More...

	Sample (const Sample &poly)
	Copy constructor. More...

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

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

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

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

virtual void	writeData (Ostream &os) const
	Write as primitive (inline) format. More...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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)

	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 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...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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)

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 Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Detailed Description

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

Definition at line 65 of file SampleFunction1.H.

Constructor & Destructor Documentation

◆ Sample() [1/3]

Sample	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 72 of file SampleFunction1.C.

◆ Sample() [2/3]

Sample	(	const word &	entryName,
		const List< Tuple2< Type, Type >> &	coeffs,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from components.

◆ Sample() [3/3]

Sample ( const Sample< Type > & poly )

explicit

Copy constructor.

Definition at line 91 of file SampleFunction1.C.

◆ ~Sample()

virtual ~Sample ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sample" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 124 of file SampleFunction1.H.

◆ value()

Type value ( const scalar x ) const

virtual

Return Sample value.

Reimplemented from Function1< Type >.

Definition at line 105 of file SampleFunction1.C.

References DebugInfo, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, mesh, and Foam::reduce().

Here is the call graph for this function:

◆ integrate()

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 149 of file SampleFunction1.C.

References NotImplemented, and Foam::Zero.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 174 of file SampleFunction1.C.

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

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream & os ) const

Write coefficient entries in dictionary format.

Definition at line 161 of file SampleFunction1.C.

References os().

Here is the call graph for this function:

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

src/sampling/functions/Function1/Sample/SampleFunction1.H
src/sampling/functions/Function1/Sample/SampleFunction1.C

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Sample() [1/3]

◆ Sample() [2/3]

◆ Sample() [3/3]

◆ ~Sample()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ value()

◆ integrate()

◆ writeData()

◆ writeEntries()

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