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

void	operator= (const Scale< Type > &)=delete
	No copy assignment. More...

	Scale (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. 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...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

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

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)

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

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

virtual	~Function1 ()=default
	Destructor. More...

virtual bool	constant () const
	Is value constant (i.e. independent of x) 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...

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char , int >> compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. 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
`scale`	Scaling function of type Function1<scalar>	yes
`value`	Function of type Function1<Type>	yes

Source files

Definition at line 103 of file Scale.H.

Constructor & Destructor Documentation

◆ Scale() [1/2]

Scale	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

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

◆ ~Scale()

virtual ~Scale ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "scale" )

Runtime type information.

◆ operator=()

void operator= ( const Scale< Type > & )

delete

No copy assignment.

◆ 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 77 of file Scale.C.

References Foam::name(), os(), and Function1< Type >::writeData().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream & os ) const

Write coefficient entries in dictionary format.

Definition at line 69 of file Scale.C.

References os().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/Scale/Scale.H
src/OpenFOAM/primitives/functions/Function1/Scale/Scale.C
src/OpenFOAM/primitives/functions/Function1/Scale/ScaleI.H

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Scale() [1/2]

◆ Scale() [2/2]

◆ ~Scale()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ value()

◆ writeData()

◆ writeEntries()

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