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")

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

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

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

	timeVaryingUniformFixedValueFaPatchField (const timeVaryingUniformFixedValueFaPatchField< Type > &)

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

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

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

virtual	~timeVaryingUniformFixedValueFaPatchField ()=default

const interpolationTable< Type > &	timeSeries () const

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

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

	fixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)

	fixedValueFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &)

	fixedValueFaPatchField (const fixedValueFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)

virtual bool	fixesValue () 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 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")

	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 > &)

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)

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

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

	faPatchField (const faPatchField< Type > &)

	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)

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

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

virtual	~faPatchField ()=default

const objectRegistry &	db () const

const faPatch &	patch () const

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

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

virtual bool	fixesValue () const

virtual bool	coupled () const

bool	updated () const

virtual void	autoMap (const faPatchFieldMapper &)

virtual void	rmap (const faPatchField< Type > &, const labelList &)

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

virtual tmp< Field< Type > >	patchInternalField () 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 > >	gradientBoundaryCoeffs () const

void	check (const faPatchField< Type > &) const

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

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

virtual void	operator== (const Type &)

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 &)

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

static const word &	calculatedType ()

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField

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 105 of file timeVaryingUniformFixedValueFaPatchField.H.

Constructor & Destructor Documentation

◆ timeVaryingUniformFixedValueFaPatchField() [1/5]

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

Definition at line 29 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [2/5]

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

Definition at line 42 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
	)

Definition at line 65 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [4/5]

timeVaryingUniformFixedValueFaPatchField ( const timeVaryingUniformFixedValueFaPatchField< Type > & ptf )

Definition at line 80 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ timeVaryingUniformFixedValueFaPatchField() [5/5]

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

Definition at line 92 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ ~timeVaryingUniformFixedValueFaPatchField()

virtual ~timeVaryingUniformFixedValueFaPatchField ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "timeVaryingUniformFixedValue" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 154 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 171 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ timeSeries()

const interpolationTable<Type>& timeSeries ( ) const

inline

Definition at line 191 of file timeVaryingUniformFixedValueFaPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from faPatchField< Type >.

Definition at line 105 of file timeVaryingUniformFixedValueFaPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedValueFaPatchField< Type >.

Definition at line 122 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 >