Function1 which scales a given 'value' function by a scalar 'scale' function. More...

Inheritance diagram for Scale< Type >:

Collaboration diagram for Scale< Type >:

Public Member Functions
	TypeName ("scale")

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

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

virtual	~Scale ()
	Destructor. More...

virtual Type	value (const scalar t) const
	Return value for time t. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

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

	Function1 (const word &entryName)
	Construct from entry name. More...

	Function1 (const Function1< Type > &f1)
	Copy constructor. More...

virtual tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~Function1 ()
	Destructor. More...

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

virtual void	convertTimeBase (const Time &t)
	Convert time. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const =0
	Return value as a function of (scalar) independent variable. More...

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...

virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const =0
	Integrate between two (scalar) values. 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 Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict)
	Selector. More...

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary	entryName

const word const dictionary	dict

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

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

Detailed Description

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

Function1 which scales a given 'value' function by a scalar 'scale' function.

This is particularly useful to ramp a time-varying value by one of the monotonic ramp functions.

Usage for a vector:

    <entryName>
    {
        type      scale;

        scale
        {
            type        linearRamp;

            start       0;
            duration    10;
        }

        value
        {
            type        sine;

            frequency   10;
            amplitude   1;
            scale       (1 0.1 0);
            level       (10 1 0);
        }
    }

Where:

Property	Description	Required
`value`	Function of type Function1<Type>	yes
`scale`	Scaling function of type Function1<scalar>	yes

Source files

Definition at line 100 of file Scale.H.

Constructor & Destructor Documentation

◆ Scale() [1/2]

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

Construct from entry name and dictionary.

Definition at line 40 of file Scale.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 52 of file Scale.C.

◆ ~Scale()

~Scale ( )

virtual

Destructor.

Definition at line 63 of file Scale.C.

Member Function Documentation

◆ TypeName()

TypeName ( "scale" )

◆ value()

Type value ( const scalar t ) const

inlinevirtual

Return value for time t.

Reimplemented from Function1< Type >.

Definition at line 31 of file ScaleI.H.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 70 of file Scale.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, token::END_STATEMENT, Foam::endl(), Foam::incrIndent(), Foam::indent(), Function1< Type >::name(), Foam::nl, and Function1< Type >::writeData().