This condition applies a scalar multiplier to the value of another boundary condition. More...

Inheritance diagram for scaledFixedValueFvPatchField< Type >:

Collaboration diagram for scaledFixedValueFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("scaledFixedValue")

	scaledFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	scaledFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	scaledFixedValueFvPatchField (const scaledFixedValueFvPatchField &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	scaledFixedValueFvPatchField (const scaledFixedValueFvPatchField &)

virtual tmp< fvPatchField< Type > >	clone () const

	scaledFixedValueFvPatchField (const scaledFixedValueFvPatchField &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const

const fvPatchField< Type > &	refValue () const

virtual void	autoMap (const fvPatchFieldMapper &m)

virtual void	rmap (const fvPatchField< Type > &ptf, const labelList &addr)

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

virtual void	operator== (const fvPatchField< Type > &ptf)

virtual void	operator== (const Field< Type > &tf)

virtual void	operator== (const Type &t)

Public Member Functions inherited from fixedValueFvPatchField< Type >
	TypeName ("fixedValue")

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone () const

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

const DimensionedField< Type, volMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual tmp< Field< Type > >	snGrad () const

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

void	check (const fvPatchField< Type > &) const

Protected Attributes
autoPtr< PatchFunction1< scalar > >	scalePtr_

tmp< fvPatchField< Type > >	refValuePtr_

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::scaledFixedValueFvPatchField< Type >

This condition applies a scalar multiplier to the value of another boundary condition.

Usage

Property	Description	Required	Default value
`scale`	Time varying scale	yes
`patch`	patchField providing the raw patch value	yes

Example of the boundary condition specification to scale a reference velocity of (15 0 0) supplied as a fixedValue by a table of values that ramps the scale from 0 to 1 over 1 second:

    <patchName>
    {
        type            scaledFixedValue;

        scale table
        (
            (    0   0)
            (  1.0 1.0)
            (100.0 1.0)
        );

        refValue
        {
            type            fixedValue;
            value           uniform (15 0 0);
        }
    }

Source files

See also: Foam::PatchFunction1

Definition at line 100 of file scaledFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ scaledFixedValueFvPatchField() [1/5]

scaledFixedValueFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 29 of file scaledFixedValueFvPatchField.C.

Referenced by scaledFixedValueFvPatchField< Type >::clone().

Here is the caller graph for this function:

◆ scaledFixedValueFvPatchField() [2/5]

scaledFixedValueFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 42 of file scaledFixedValueFvPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::isA(), Foam::operator==(), and s.

Here is the call graph for this function:

◆ scaledFixedValueFvPatchField() [3/5]

scaledFixedValueFvPatchField	(	const scaledFixedValueFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 67 of file scaledFixedValueFvPatchField.C.

◆ scaledFixedValueFvPatchField() [4/5]

scaledFixedValueFvPatchField ( const scaledFixedValueFvPatchField< Type > & spf )

Definition at line 82 of file scaledFixedValueFvPatchField.C.

◆ scaledFixedValueFvPatchField() [5/5]

scaledFixedValueFvPatchField	(	const scaledFixedValueFvPatchField< Type > &	spf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 94 of file scaledFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "scaledFixedValue" )

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 152 of file scaledFixedValueFvPatchField.H.

References scaledFixedValueFvPatchField< Type >::scaledFixedValueFvPatchField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 169 of file scaledFixedValueFvPatchField.H.

References scaledFixedValueFvPatchField< Type >::scaledFixedValueFvPatchField().

Here is the call graph for this function:

◆ refValue()

const fvPatchField<Type>& refValue ( ) const

inline

Definition at line 185 of file scaledFixedValueFvPatchField.H.

References scaledFixedValueFvPatchField< Type >::refValuePtr_.

Referenced by scaledFixedValueFvPatchField< Type >::rmap().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 109 of file scaledFixedValueFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ rmap()

void rmap	(	const fvPatchField< Type > &	ptf,
		const labelList &	addr
	)

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 128 of file scaledFixedValueFvPatchField.C.

References scaledFixedValueFvPatchField< Type >::refValue(), and scaledFixedValueFvPatchField< Type >::scalePtr_.

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 145 of file scaledFixedValueFvPatchField.C.

References s.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 164 of file scaledFixedValueFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

◆ operator==() [1/3]

void operator== ( const fvPatchField< Type > & ptf )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 178 of file scaledFixedValueFvPatchField.C.

References forAll, Foam::mag(), and s.

Here is the call graph for this function:

◆ operator==() [2/3]

void operator== ( const Field< Type > & tf )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 198 of file scaledFixedValueFvPatchField.C.

References forAll, Foam::mag(), and s.

Here is the call graph for this function:

◆ operator==() [3/3]

void operator== ( const Type & t )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 216 of file scaledFixedValueFvPatchField.C.

References forAll, Foam::mag(), and s.

Here is the call graph for this function:

Member Data Documentation

◆ scalePtr_

autoPtr<PatchFunction1<scalar> > scalePtr_

protected

Definition at line 109 of file scaledFixedValueFvPatchField.H.

Referenced by scaledFixedValueFvPatchField< Type >::rmap().

◆ refValuePtr_

tmp<fvPatchField<Type> > refValuePtr_

protected

Definition at line 112 of file scaledFixedValueFvPatchField.H.

Referenced by scaledFixedValueFvPatchField< Type >::refValue().

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

src/finiteVolume/fields/fvPatchFields/derived/scaledFixedValue/scaledFixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/scaledFixedValue/scaledFixedValueFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::scaledFixedValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ scaledFixedValueFvPatchField() [1/5]

◆ scaledFixedValueFvPatchField() [2/5]

◆ scaledFixedValueFvPatchField() [3/5]

◆ scaledFixedValueFvPatchField() [4/5]

◆ scaledFixedValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ refValue()

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

Member Data Documentation

◆ scalePtr_

◆ refValuePtr_

template<class Type>
class Foam::scaledFixedValueFvPatchField< Type >