Classes | Public Member Functions | Static Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for objectFunction1:
Collaboration graph
[legend]

Public Member Functions

 ~objectFunction1 ()
 Destructor. More...
 
template<class PrimitiveType >
PrimitiveType value (const scalar x) const
 Return value as a function of scalar x. More...
 
template<class PrimitiveType >
tmp< Field< PrimitiveType > > value (const scalarField &x) const
 Return value as a function of scalarField x. More...
 
template<class PrimitiveType >
PrimitiveType integral (const scalar x1, const scalar x2) const
 Integrate between two scalars. More...
 
template<class PrimitiveType >
tmp< Field< PrimitiveType > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
void operator= (const objectFunction1 &)=delete
 Disallow default bitwise assignment. More...
 
template<template< class > class ObjectType>
Foam::autoPtr< Foam::objectFunction1 > New (const word &name, const dictionary &dict, const word &objectName, const objectRegistry &db, const bool error)
 
template<class PrimitiveType >
Foam::tmp< Foam::Field< PrimitiveType > > value (const scalarField &x) const
 
template<class PrimitiveType >
Foam::tmp< Foam::Field< PrimitiveType > > integral (const scalarField &x1, const scalarField &x2) const
 

Static Public Member Functions

template<template< class > class ObjectType>
static autoPtr< objectFunction1 > New (const word &name, const dictionary &dict, const word &objectName, const objectRegistry &db, const bool error=true)
 

Detailed Description

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

Source files

Definition at line 50 of file objectFunction1.H.

Constructor & Destructor Documentation

◆ ~objectFunction1()

~objectFunction1 ( )
inline

Destructor.

Definition at line 94 of file objectFunction1.H.

References objectFunction1::integral(), objectFunction1::operator=(), objectFunction1::value(), and x.

Here is the call graph for this function:

Member Function Documentation

◆ New() [1/2]

static autoPtr<objectFunction1> New ( const word &  name,
const dictionary &  dict,
const word &  objectName,
const objectRegistry &  db,
const bool  error = true 
)
static

◆ value() [1/3]

PrimitiveType value ( const scalar  x) const

Return value as a function of scalar x.

Definition at line 86 of file objectFunction1Templates.C.

Referenced by objectFunction1::New(), 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 scalarField x.

◆ integral() [1/3]

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

Integrate between two scalars.

Definition at line 106 of file objectFunction1Templates.C.

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

Here is the caller graph for this function:

◆ integral() [2/3]

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

Integrate between two scalar fields.

◆ operator=()

void operator= ( const objectFunction1 &  )
delete

Disallow default bitwise assignment.

Referenced by objectFunction1::~objectFunction1().

Here is the caller graph for this function:

◆ New() [2/2]

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

Definition at line 49 of file objectFunction1Templates.C.

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

Here is the call graph for this function:

◆ value() [3/3]

Foam::tmp<Foam::Field<PrimitiveType> > value ( const scalarField &  x) const

Definition at line 96 of file objectFunction1Templates.C.

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

Here is the call graph for this function:

◆ integral() [3/3]

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

Definition at line 117 of file objectFunction1Templates.C.

References objectFunction1::integral().

Here is the call graph for this function:
The documentation for this class was generated from the following files: