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")
	Runtime type information. More...

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

	Scale (const Scale< Type > &rhs)
	Copy construct. More...

virtual	~Scale ()=default
	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 > &rhs)
	Copy constructor. More...

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

virtual	~Function1 ()=default
	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
	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
	Integrate between two (scalar) values. 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, const word &redirectType=word::null)
	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 Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. 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 102 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 42 of file Scale.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ Scale() [2/2]

Scale ( const Scale< Type > & rhs )

explicit

Copy construct.

Definition at line 54 of file Scale.C.

◆ ~Scale()

virtual ~Scale ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "scale" )

Runtime type information.

◆ value()

Type value ( const scalar t ) const

inlinevirtual

Return value for time t.

Reimplemented from Function1< Type >.

Definition at line 33 of file ScaleI.H.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 65 of file Scale.C.

References Ostream::beginBlock(), token::END_STATEMENT, Ostream::endBlock(), Foam::name(), Foam::nl, and Function1< Type >::writeData().