A time-varying form of a uniform fixed value finite area boundary condition. More...

Inheritance diagram for timeVaryingUniformFixedValueFaPatchField< Type >:

Collaboration diagram for timeVaryingUniformFixedValueFaPatchField< Type >:

Public Member Functions
	TypeName ("timeVaryingUniformFixedValue")
	Runtime type information. More...

	timeVaryingUniformFixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	timeVaryingUniformFixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	timeVaryingUniformFixedValueFaPatchField (const timeVaryingUniformFixedValueFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...

	timeVaryingUniformFixedValueFaPatchField (const timeVaryingUniformFixedValueFaPatchField< Type > &)
	Construct as copy. More...

virtual tmp< faPatchField< Type > >	clone () const
	Construct and return a clone. More...

	timeVaryingUniformFixedValueFaPatchField (const timeVaryingUniformFixedValueFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< faPatchField< Type > >	clone (const DimensionedField< Type, areaMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

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

const interpolationTable< Type > &	timeSeries () const
	Return the time series used. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from fixedValueFaPatchField< Type >
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	fixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given fixedValueFaPatchField<Type> More...

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &)
	Construct as copy. More...

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

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

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

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

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

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

virtual void	operator/= (const faPatchField< 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 faPatchField< Type >
	TypeName ("faPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faPatchField onto a new patch. More...

	faPatchField (const faPatchField< Type > &)
	Construct as copy. More...

	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
	Construct as copy setting internal field reference. More...

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

const objectRegistry &	db () const
	Return local objectRegistry. More...

const faPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, areaMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

virtual void	autoMap (const faPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const faPatchField< Type > &, const labelList &)
	Reverse map the given faPatchField onto this faPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field, sets Updated to false. More...

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

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

void	check (const faPatchField< Type > &) const
	Check faPatchField<Type> against given faPatchField<Type> More...

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

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

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &pf)

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)

static const word &	calculatedType ()
	Return the type of the calculated for of faPatchField. More...

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField
	Debug switch to disallow the use of. More...

Detailed Description

template<class Type>
class Foam::timeVaryingUniformFixedValueFaPatchField< Type >

A time-varying form of a uniform fixed value finite area boundary condition.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type                timeVaryingUniformFixedValue;
    fileName            "<case>/time-series";
    outOfBounds         clamp;           // (error|warn|clamp|repeat)

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: timeVaryingUniformFixedValue	word	yes	-
`fileName`	Name of operand file	word	yes	-

The inherited entries are elaborated in:

faPatchFields.H

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Note: This class is derived directly from a fixedValue patch rather than from a uniformFixedValue patch.

See also

Source files

Definition at line 109 of file timeVaryingUniformFixedValueFaPatchField.H.

Constructor & Destructor Documentation

◆ timeVaryingUniformFixedValueFaPatchField() [1/5]

timeVaryingUniformFixedValueFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 36 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [2/5]

timeVaryingUniformFixedValueFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 49 of file timeVaryingUniformFixedValueFaPatchField.C.

References dict, Foam::operator==(), and p.

Here is the call graph for this function:

◆ timeVaryingUniformFixedValueFaPatchField() [3/5]

timeVaryingUniformFixedValueFaPatchField	(	const timeVaryingUniformFixedValueFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping given patch field onto a new patch.

Definition at line 72 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [4/5]

timeVaryingUniformFixedValueFaPatchField ( const timeVaryingUniformFixedValueFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 87 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [5/5]

timeVaryingUniformFixedValueFaPatchField	(	const timeVaryingUniformFixedValueFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 99 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ ~timeVaryingUniformFixedValueFaPatchField()

virtual ~timeVaryingUniformFixedValueFaPatchField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "timeVaryingUniformFixedValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 158 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 175 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ timeSeries()

const interpolationTable<Type>& timeSeries ( ) const

inline

Return the time series used.

Definition at line 195 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from faPatchField< Type >.

Definition at line 112 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 129 of file timeVaryingUniformFixedValueFaPatchField.C.

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

Here is the call graph for this function:

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

src/finiteArea/fields/faPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValueFaPatchField.H
src/finiteArea/fields/faPatchFields/derived/timeVaryingUniformFixedValue/timeVaryingUniformFixedValueFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::timeVaryingUniformFixedValueFaPatchField< Type >

Constructor & Destructor Documentation

◆ timeVaryingUniformFixedValueFaPatchField() [1/5]

◆ timeVaryingUniformFixedValueFaPatchField() [2/5]

◆ timeVaryingUniformFixedValueFaPatchField() [3/5]

◆ timeVaryingUniformFixedValueFaPatchField() [4/5]

◆ timeVaryingUniformFixedValueFaPatchField() [5/5]

◆ ~timeVaryingUniformFixedValueFaPatchField()

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ timeSeries()

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::timeVaryingUniformFixedValueFaPatchField< Type >