Foam::Function2s Namespace Reference

Classes
class	coded
class	Coded
	Constructs a dynamically compiled function of two variables. More...
class	Constant
	Templated function of two variables that returns a constant value. More...
class	Function12
	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...
struct	unitConversions
class	None
	Undefined Function2 which returns an error when called. More...
class	OneConstant
	Templated function of two variables that returns the corresponding 1 (one). More...
struct	ProductValueTypeIsValid
struct	ProductValueTypeIsValid< Type, scalar >
struct	ProductValueTypeIsValid< Type, ValueType, typename std::enable_if<(pTraits< ValueType >::rank > 0) &&(pTraits< ValueType >::rank<=pTraits< Type >::rank) >::type >
struct	ProductFilter
class	ProductFunction1s
class	ProductFunction1s< Type, 0 >
class	Product
	Function2 which returns the product of two independent Function1-s of the two input arguments. The two function1s are specified as value1 and value2. More...
class	Radial
	Function2 which returns a Function1 of the magnitude of the two-dimensional vector with components equal to the input arguments. More...
class	Scale
	Function2 which scales a given 'value' function by a 'scale' scalar function and scales the 'x' and 'y' arguments of the 'value' and 'scale' functions by the optional 'xScale' and 'yScale' scalar functions. More...
class	UniformTable
	Tabulated property function that linearly interpolates between the uniformTable values. More...
class	ZeroConstant
	Templated function of two variables that returns the corresponding 0 (zero). More...
class	APIdiffCoef

Functions
	addFunction2 (None, label)
	addStreamConstructableFunction2 (Constant, label)
word	valueName (const direction argument)
	Return the name of the value entry for the given argument. More...
word	valueName (const direction argument, const word &typeName)
	Return the name of the value entry for the given argument and type name. More...
word	valueName (const direction argument, const Tuple2< word, label > &typeAndRank)
	Return the name of the value entry for the given argument and type and rank. More...
template<class Type , class ValueType >
void	lookupValueTypeAndRank (const dictionary &dict, const direction argument, Tuple2< word, label > &typeAndRank, label &found)
	Lookup the type and rank for the value entry for the given argument. More...
template<class Type >
Tuple2< word, label >	lookupValueTypeAndRank (const dictionary &dict, const direction argument)
	Lookup the type and rank for the value entry for the given argument. More...
template<class Type >
Pair< Tuple2< word, label > >	lookupValueTypeAndRanks (const dictionary &dict)
	Lookup the types and ranks for the value entries. More...
	addScalarFunction2 (APIdiffCoef)

Function Documentation

addFunction2()

Foam::Function2s::addFunction2	(	None	,
		label
	)

addStreamConstructableFunction2()

Foam::Function2s::addStreamConstructableFunction2	(	Constant	,
		label
	)

valueName() [1/3]

Foam::word valueName ( const direction  argument )

inline

Return the name of the value entry for the given argument.

Return the name of the value entry for the given argument and type.

Definition at line 81 of file Product2I.H.

References Foam::name().

Referenced by phaseSystem::generateInterfacialValues(), lookupValueTypeAndRank(), ProductFunction1s< Type, rank >::ProductFunction1s(), ProductFunction1s< Type, 0 >::ProductFunction1s(), and valueName().

Here is the call graph for this function:

Here is the caller graph for this function:

valueName() [2/3]

Foam::word valueName ( const direction  argument, const word &  typeName  )

inline

Return the name of the value entry for the given argument and type name.

Definition at line 87 of file Product2I.H.

References valueName().

Here is the call graph for this function:

valueName() [3/3]

Foam::word valueName ( const direction  argument, const Tuple2< word, label > &  typeAndRank  )

inline

Return the name of the value entry for the given argument and type and rank.

Definition at line 107 of file Product2I.H.

References Tuple2< Type1, Type2 >::first(), and valueName().

Here is the call graph for this function:

lookupValueTypeAndRank() [1/2]

void lookupValueTypeAndRank	(	const dictionary &	dict,
		const direction	argument,
		Tuple2< word, label > &	typeAndRank,
		label &	found
	)

Lookup the type and rank for the value entry for the given argument.

Definition at line 189 of file Product2.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, found, and valueName().

Here is the call graph for this function:

lookupValueTypeAndRank() [2/2]

Tuple2<word, label> Foam::Function2s::lookupValueTypeAndRank	(	const dictionary &	dict,
		const direction	argument
	)

Lookup the type and rank for the value entry for the given argument.

lookupValueTypeAndRanks()

Pair<Tuple2<word, label> > Foam::Function2s::lookupValueTypeAndRanks

(

const dictionary &

dict

)

Lookup the types and ranks for the value entries.

addScalarFunction2()

Foam::Function2s::addScalarFunction2

(

APIdiffCoef

)