This boundary conditions interpolates the values from a set of supplied points in space and time. Supplied data should be specified in constant/boundaryData/<patchname> where: More...

Inheritance diagram for timeVaryingMappedFixedValueFvPatchField< Type >:

[legend]

Collaboration diagram for timeVaryingMappedFixedValueFvPatchField< Type >:

[legend]

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

	timeVaryingMappedFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	timeVaryingMappedFixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	timeVaryingMappedFixedValueFvPatchField (const timeVaryingMappedFixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given timeVaryingMappedFixedValueFvPatchField. More...

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

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

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

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

const Field< Type >	startSampledValues ()
	Return startSampledValues. More...

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

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

void	checkTable ()
	Find boundary data inbetween current time and interpolate. 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 fixedValueFvPatchField< Type >
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fixedValueFvPatchField<Type> More...

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

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	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 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")
	Runtime type information. More...

	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 > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

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

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

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

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

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

virtual	~fvPatchField ()
	Destructor. More...

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

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

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

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

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

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

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. 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...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

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

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

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

virtual void	patchInternalField (Field< Type > &) 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::blocking)
	Initialise the evaluation of the patch field. More...

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

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

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) 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 tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

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

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

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

virtual void	operator== (const Type &)

Private Attributes
word	fieldTableName_
	Name of the field data table, defaults to the name of the field. More...

bool	setAverage_
	If true adjust the mapped field to maintain average value. More...

scalar	perturb_
	Fraction of perturbation (fraction of bounding box) to add. More...

word	mapMethod_
	Interpolation scheme to use. More...

autoPtr< pointToPointPlanarInterpolation >	mapperPtr_
	2D interpolation (for 'planarInterpolation' mapMethod) More...

instantList	sampleTimes_
	List of boundaryData time directories. More...

label	startSampleTime_
	Current starting index in sampleTimes. More...

Field< Type >	startSampledValues_
	Interpolated values from startSampleTime. More...

Type	startAverage_
	If setAverage: starting average value. More...

label	endSampleTime_
	Current end index in sampleTimes. More...

Field< Type >	endSampledValues_
	Interpolated values from endSampleTime. More...

Type	endAverage_
	If setAverage: end average value. More...

autoPtr< DataEntry< Type > >	offset_
	Time varying offset values to interpolated data. More...

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

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

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

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::timeVaryingMappedFixedValueFvPatchField< Type >

This boundary conditions interpolates the values from a set of supplied points in space and time. Supplied data should be specified in constant/boundaryData/<patchname> where:

- points : pointField with locations

ddd : supplied values at time ddd The default mode of operation (mapMethod planarInterpolation) is to project the points onto a plane (constructed from the first threee points) and construct a 2D triangulation and finds for the face centres the triangle it is in and the weights to the 3 vertices.

The optional mapMethod nearest will avoid all projection and triangulation and just use the value at the nearest vertex.

Values are interpolated linearly between times.

Patch usage

Property	Description	Required	Default value
`setAverage`	flag to activate setting of average value	yes
`perturb`	perturb points for regular geometries	no	1e-5
`fieldTableName`	alternative field name to sample	no	this field name
`mapMethod`	type of mapping	no	planarInterpolation
`offset`	for applying offset to mapped values	no	constant 0.0

    myPatch
    {
        type            timeVaryingMappedFixedValue;
        setAverage      false;
        //perturb       0.0;
        //fieldTableName samples;
        //offset    constant 0.2;
    }

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 124 of file timeVaryingMappedFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ timeVaryingMappedFixedValueFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 40 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 64 of file timeVaryingMappedFixedValueFvPatchField.C.

References UPstream::blocking, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), fvPatchField::operator==(), p, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ timeVaryingMappedFixedValueFvPatchField() [3/5]

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

Construct by mapping given timeVaryingMappedFixedValueFvPatchField.

onto a new patch

Definition at line 126 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [4/5]

timeVaryingMappedFixedValueFvPatchField ( const timeVaryingMappedFixedValueFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 153 of file timeVaryingMappedFixedValueFvPatchField.C.

◆ timeVaryingMappedFixedValueFvPatchField() [5/5]

timeVaryingMappedFixedValueFvPatchField	(	const timeVaryingMappedFixedValueFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 177 of file timeVaryingMappedFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "timeVaryingMappedFixedValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 210 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 227 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ startSampledValues()

const Field<Type> startSampledValues ( )

inline

Return startSampledValues.

Definition at line 243 of file timeVaryingMappedFixedValueFvPatchField.H.

References timeVaryingMappedFixedValueFvPatchField< Type >::startSampledValues_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from fvPatchField< Type >.

Definition at line 203 of file timeVaryingMappedFixedValueFvPatchField.C.

References fvPatchField< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 222 of file timeVaryingMappedFixedValueFvPatchField.C.

References timeVaryingMappedFixedValueFvPatchField< Type >::endSampledValues_, timeVaryingMappedFixedValueFvPatchField< Type >::rmap(), fvPatchField< Type >::rmap(), and timeVaryingMappedFixedValueFvPatchField< Type >::startSampledValues_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTable()

void checkTable

Find boundary data inbetween current time and interpolate.

Definition at line 243 of file timeVaryingMappedFixedValueFvPatchField.C.

References IOobject::AUTO_WRITE, AverageIOField< Type >::average(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::filePath(), Time::findTimes(), Foam::Info, IOobject::MUST_READ, OSstream::name(), fileName::name(), Foam::name(), Foam::nl, IOobject::objectPath(), fileName::path(), Foam::Pout, and pointToPointPlanarInterpolation::timeNames().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 454 of file timeVaryingMappedFixedValueFvPatchField.C.

References Foam::endl(), fld(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::gSum(), Foam::mag(), OSstream::name(), fileName::name(), Foam::nl, Foam::operator==(), Foam::Pout, s(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 559 of file timeVaryingMappedFixedValueFvPatchField.C.

References dimensionedInternalField(), Foam::e, token::END_STATEMENT, Foam::name(), Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ fieldTableName_

word fieldTableName_

private

Name of the field data table, defaults to the name of the field.

Definition at line 131 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ setAverage_

bool setAverage_

private

If true adjust the mapped field to maintain average value.

Definition at line 134 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ perturb_

scalar perturb_

private

Fraction of perturbation (fraction of bounding box) to add.

Definition at line 137 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ mapMethod_

word mapMethod_

private

Interpolation scheme to use.

Definition at line 140 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ mapperPtr_

autoPtr<pointToPointPlanarInterpolation> mapperPtr_

private

2D interpolation (for 'planarInterpolation' mapMethod)

Definition at line 143 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ sampleTimes_

instantList sampleTimes_

private

List of boundaryData time directories.

Definition at line 146 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ startSampleTime_

label startSampleTime_

private

Current starting index in sampleTimes.

Definition at line 149 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ startSampledValues_

Field<Type> startSampledValues_

private

Interpolated values from startSampleTime.

Definition at line 152 of file timeVaryingMappedFixedValueFvPatchField.H.

Referenced by timeVaryingMappedFixedValueFvPatchField< Type >::rmap(), and timeVaryingMappedFixedValueFvPatchField< Type >::startSampledValues().

◆ startAverage_

Type startAverage_

private

If setAverage: starting average value.

Definition at line 155 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ endSampleTime_

label endSampleTime_

private

Current end index in sampleTimes.

Definition at line 158 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ endSampledValues_

Field<Type> endSampledValues_

private

Interpolated values from endSampleTime.

Definition at line 161 of file timeVaryingMappedFixedValueFvPatchField.H.

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

◆ endAverage_

Type endAverage_

private

If setAverage: end average value.

Definition at line 164 of file timeVaryingMappedFixedValueFvPatchField.H.

◆ offset_

autoPtr<DataEntry<Type> > offset_

private

Time varying offset values to interpolated data.

Definition at line 167 of file timeVaryingMappedFixedValueFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::timeVaryingMappedFixedValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ timeVaryingMappedFixedValueFvPatchField() [1/5]

◆ timeVaryingMappedFixedValueFvPatchField() [2/5]

◆ timeVaryingMappedFixedValueFvPatchField() [3/5]

◆ timeVaryingMappedFixedValueFvPatchField() [4/5]

◆ timeVaryingMappedFixedValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ startSampledValues()

◆ autoMap()

◆ rmap()

◆ checkTable()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ fieldTableName_

◆ setAverage_

◆ perturb_

◆ mapMethod_

◆ mapperPtr_

◆ sampleTimes_

◆ startSampleTime_

◆ startSampledValues_

◆ startAverage_

◆ endSampleTime_

◆ endSampledValues_

◆ endAverage_

◆ offset_

template<class Type>
class Foam::timeVaryingMappedFixedValueFvPatchField< Type >