Function1 which scales a given 'value' function so that its integral within specified bounds is equal to one. More...

Inheritance diagram for normalise:

Collaboration diagram for normalise:

Public Member Functions
	TypeName ("normalise")

	normalise (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

	normalise (const normalise &se)
	Copy constructor. More...

virtual	~normalise ()
	Destructor. More...

virtual scalar	value (const scalar x) const
	Return value. More...

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

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

void	operator= (const normalise &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< scalar, normalise >
	FieldFunction1 (const word &name)
	Construct from name. More...

virtual tmp< Function1< scalar > >	clone () const
	Construct and return a clone. More...

virtual	~FieldFunction1 ()
	Destructor. More...

virtual tmp< Field< scalar > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...

virtual tmp< Field< scalar > >	integral (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields. More...

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

	declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))

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

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

virtual	~Function1 ()
	Destructor. More...

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

virtual bool	constant () const
	Is this function guaranteed to be constant? More...

void	operator= (const Function1< scalar > &)
	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...

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Additional Inherited Members
Public Types inherited from Function1< scalar >
typedef scalar	returnType

Static Public Member Functions inherited from Function1< scalar >
static autoPtr< Function1< scalar > >	New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< scalar > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< scalar > >	New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function1< scalar > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
	Select from Istream. More...

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

	refCount (const refCount &)=delete
	Disallow copy. More...

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

Detailed Description

Function1 which scales a given 'value' function so that its integral within specified bounds is equal to one.

Usage

Example of use within a scale function to scale a given profile to a desired total integral value:

    <name>
    {
        type    scale;

        scale
        {
            type    normalise;

            bounds  (0 1.5);

            value
            {
                type    table;
                values
                (
                    (0    0.1272)
                    (0.25 8.7011)
                    (0.5  8.8882)
                    (0.75 6.7608)
                    (1    4.9547)
                    (1.25 3.9213)
                    (1.5  0     )
                );
            }
        }

        value   constant 6e-6;
    }

Where:

Property	Description	Data type	Default
`bounds`	Bounds of the integration	Pair<scalar>
`value`	Function to normalise	Function1<Type>

Source files

Definition at line 107 of file normalise.H.

Constructor & Destructor Documentation

◆ normalise() [1/2]

normalise	(	const word &	name,
		const unitConversions &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 41 of file normalise.C.

References Foam::unitAny, and Foam::units().

Here is the call graph for this function:

◆ normalise() [2/2]

normalise ( const normalise & se )

Copy constructor.

Definition at line 55 of file normalise.C.

◆ ~normalise()

~normalise ( )

virtual

Destructor.

Definition at line 66 of file normalise.C.

Member Function Documentation

◆ TypeName()

TypeName ( "normalise" )

◆ value()

Foam::scalar value ( const scalar x ) const

inlinevirtual

Return value.

Implements FieldFunction1< scalar, normalise >.

Definition at line 30 of file normaliseI.H.

References x.

◆ integral()

Foam::scalar integral	(	const scalar	x1,
		const scalar	x2
	)		const

inlinevirtual

Integrate between two values.

Implements FieldFunction1< scalar, normalise >.

Definition at line 36 of file normaliseI.H.

◆ write()

void write	(	Ostream &	os,
		const unitConversions &	units
	)		const

virtual

Write data to dictionary stream.

Implements Function1< scalar >.

Definition at line 72 of file normalise.C.

References Foam::units(), and Foam::Function1s::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const normalise & )

delete

Disallow default bitwise assignment.

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

src/OpenFOAM/primitives/functions/Function1/normalise/normalise.H
src/OpenFOAM/primitives/functions/Function1/normalise/normalise.C
src/OpenFOAM/primitives/functions/Function1/normalise/normaliseI.H

Public Member Functions

Additional Inherited Members