Function2 which returns a Function1 using just one of the arguments given to the function2. The function1 is specified as value1 or value2, depending on which argument it is to be evaluated with. More...

Inheritance diagram for Function12< Type >:

[legend]

Collaboration diagram for Function12< Type >:

[legend]

Public Member Functions
	TypeName ("function1")

	Function12 (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

	Function12 (const Function12< Type > &se)
	Copy constructor. More...

virtual	~Function12 ()
	Destructor. More...

virtual Type	value (const scalar x, const scalar y) const
	Return value. More...

virtual void	write (Ostream &os, const unitConversions &units) const
	Write data to dictionary stream. More...

void	operator= (const Function12< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction2< Type, Function12< Type > >
	FieldFunction2 (const word &name)
	Construct from name. More...

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

virtual	~FieldFunction2 ()
	Destructor. More...

virtual tmp< Field< Type > >	value (const scalarField &x, const scalarField &y) const
	Return value as a function of two scalar fields. More...

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

	declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))

	Function2 (const word &name)
	Construct from name. More...

	Function2 (const Function2< Type > &f2)
	Copy constructor. More...

virtual	~Function2 ()
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

void	operator= (const Function2< Type > &)
	Assignment. More...

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

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

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

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

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

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

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

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

Static Public Member Functions inherited from Function2< Type >
static autoPtr< Function2< Type > >	New (const word &name, const Function2s::unitConversions &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function2< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function2< Type > >	New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function2< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
	Select from Istream. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Attributes inherited from Function2< Type >
const word	name_
	Name of entry. More...

Detailed Description

template<class Type>
class Foam::Function2s::Function12< Type >

Function2 which returns a Function1 using just one of the arguments given to the function2. The function1 is specified as value1 or value2, depending on which argument it is to be evaluated with.

Example for a scalar:

    <name>
    {
        type    function1;
        value1  constant 10; // <-- The value1 function is evaluated with
                             //     the first argument
    }

Example for a vector:

    <name>
    {
        type    function1;
        value2  table       // <-- The value2 function is evaluated with
        (                   //     the second argument
            (0.00 (0 0 0))
            (0.35 (0 0 1))
            (0.71 (0 0 0))
        );
    }

Source files

Definition at line 78 of file Function12.H.

Constructor & Destructor Documentation

◆ Function12() [1/2]

Function12	(	const word &	name,
		const unitConversions &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 31 of file Function12.C.

References dict, Foam::exit(), Foam::FatalError, FatalIOErrorInFunction, Function1< Type >::New(), and Foam::units().

Here is the call graph for this function:

◆ Function12() [2/2]

Function12 ( const Function12< Type > & se )

Copy constructor.

Definition at line 74 of file Function12.C.

◆ ~Function12()

~Function12

virtual

Destructor.

Definition at line 85 of file Function12.C.

Member Function Documentation

◆ TypeName()

TypeName ( "function1" )

◆ value()

Type value	(	const scalar	x,
		const scalar	y
	)		const

inlinevirtual

Return value.

Implements FieldFunction2< Type, Function12< Type > >.

Definition at line 32 of file Function12I.H.

References x, and y.

◆ write()

void write	(	Ostream &	os,
		const unitConversions &	units
	)		const

virtual

Write data to dictionary stream.

Implements Function2< Type >.

Definition at line 92 of file Function12.C.

References Foam::units(), and Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Function12< Type > & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function2/Function1/Function12.H
src/OpenFOAM/primitives/functions/Function2/Function1/Function12.C
src/OpenFOAM/primitives/functions/Function2/Function1/Function12I.H

Public Member Functions

Additional Inherited Members