objectFunction1 Class Reference

Wrapper around Function1 that constructs a function of type associated with an object found in the database. More...

Inheritance diagram for objectFunction1:

Collaboration diagram for objectFunction1:

Public Member Functions
	~objectFunction1 ()
	Destructor. More...
template<class PrimitiveType >
PrimitiveType	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...
template<class PrimitiveType >
tmp< Field< PrimitiveType > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable. More...
template<class PrimitiveType >
PrimitiveType	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...
template<class PrimitiveType >
tmp< Field< PrimitiveType > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...
void	operator= (const objectFunction1 &)=delete
	Disallow default bitwise assignment. More...
template<template< class > class ObjectType>
Foam::autoPtr< Foam::objectFunction1 >	New (const word &entryName, const dictionary &dict, const word &objectName, const objectRegistry &db)
template<class PrimitiveType >
Foam::tmp< Foam::Field< PrimitiveType > >	value (const scalarField &x) const
template<class PrimitiveType >
Foam::tmp< Foam::Field< PrimitiveType > >	integrate (const scalarField &x1, const scalarField &x2) const

Static Public Member Functions
template<template< class > class ObjectType>
static autoPtr< objectFunction1 >	New (const word &entryName, const dictionary &dict, const word &objectName, const objectRegistry &db)

Detailed Description

Wrapper around Function1 that constructs a function of type associated with an object found in the database.

Source files

• objectFunction1.H
• objectFunction1Templates.C

Definition at line 50 of file objectFunction1.H.

Constructor & Destructor Documentation

~objectFunction1()

~objectFunction1

(

)

Destructor.

Definition at line 83 of file objectFunction1Templates.C.

References objectFunction1::value().

Here is the call graph for this function:

Member Function Documentation

New() [1/2]

static autoPtr<objectFunction1> New ( const word &  entryName, const dictionary &  dict, const word &  objectName, const objectRegistry &  db  )

static

value() [1/3]

PrimitiveType value

(

const scalar

x

)

const

Return value as a function of (scalar) independent variable.

Definition at line 91 of file objectFunction1Templates.C.

Referenced by objectFunction1::value(), and objectFunction1::~objectFunction1().

Here is the caller graph for this function:

value() [2/3]

tmp<Field<PrimitiveType> > value

(

const scalarField &

x

)

const

Return value as a function of (scalar) independent variable.

integrate() [1/3]

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

Integrate between two (scalar) values.

Definition at line 111 of file objectFunction1Templates.C.

Referenced by objectFunction1::integrate(), and objectFunction1::value().

Here is the caller graph for this function:

integrate() [2/3]

tmp<Field<PrimitiveType> > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

Integrate between two (scalar) values.

operator=()

void operator= ( const objectFunction1 &  )

delete

Disallow default bitwise assignment.

New() [2/2]

Foam::autoPtr<Foam::objectFunction1> New	(	const word &	entryName,
		const dictionary &	dict,
		const word &	objectName,
		const objectRegistry &	db
	)

Definition at line 49 of file objectFunction1Templates.C.

References objectRegistry::foundObject(), objectRegistry::lookupObject(), autoPtr< Function1< sphericalTensor > >::ptr(), and autoPtr< T >::valid().

Here is the call graph for this function:

value() [3/3]

Foam::tmp<Foam::Field<PrimitiveType> > value

(

const scalarField &

x

)

const

Definition at line 101 of file objectFunction1Templates.C.

References objectFunction1::integrate(), and objectFunction1::value().

Here is the call graph for this function:

integrate() [3/3]

Foam::tmp<Foam::Field<PrimitiveType> > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

Definition at line 122 of file objectFunction1Templates.C.

References objectFunction1::integrate().

Here is the call graph for this function:

---

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

• src/OpenFOAM/primitives/functions/Function1/objectFunction1/objectFunction1.H
• src/OpenFOAM/primitives/functions/Function1/objectFunction1/objectFunction1Templates.C