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

Inheritance diagram for Scale< Type >:

[legend]

Collaboration diagram for Scale< Type >:

[legend]

Public Member Functions
	TypeName ("scale")

	Scale (const word &name, const dictionary &dict)
	Construct from name and dictionary. More...

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

virtual	~Scale ()
	Destructor. More...

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

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

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

Public Member Functions inherited from FieldFunction2< Type, Scale< 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 dictionary &dict),(name, dict))
	Declare runtime constructor selection table. More...

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

	Function2 (const Function2< Type > &f1)
	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...

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 dictionary &dict)
	Selector. More...

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

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

Detailed Description

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

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.

See also: Foam::Function2s::ramp Foam::Function2s::reverseRamp

Source files

Definition at line 58 of file Scale2.H.

Constructor & Destructor Documentation

◆ Scale() [1/2]

Scale	(	const word &	name,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 56 of file Scale2.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ Scale() [2/2]

Scale ( const Scale< Type > & se )

Copy constructor.

Definition at line 68 of file Scale2.C.

◆ ~Scale()

~Scale ( )

virtual

Destructor.

Definition at line 81 of file Scale2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "scale" )

◆ value()

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

inlinevirtual

Return value.

Implements FieldFunction2< Type, Scale< Type > >.

Definition at line 32 of file Scale2I.H.

References x, and y.

◆ write()

void write ( Ostream & os ) const

virtual

Write data to dictionary stream.

Implements Function2< Type >.

Definition at line 88 of file Scale2.C.

References Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Scale< Type > & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function2/Scale/Scale2.H
src/OpenFOAM/primitives/functions/Function2/Scale/Scale2.C
src/OpenFOAM/primitives/functions/Function2/Scale/Scale2I.H

Public Member Functions

Additional Inherited Members