This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this. More...

Inheritance diagram for mappedFixedInternalValueFvPatchField< Type >:

[legend]

Collaboration diagram for mappedFixedInternalValueFvPatchField< Type >:

[legend]

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

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

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

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

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

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

	mappedFixedInternalValueFvPatchField (const mappedFixedInternalValueFvPatchField< 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...

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

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

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

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

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

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

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

	mappedFixedValueFvPatchField (const mappedFixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. 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 Type &value)
	Construct from patch, internal field and value. More...

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	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 bool	assignable () const
	Return false: this patch field is not altered by assignment. 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 Type &value)
	Construct from patch, internal field and value. 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=true)
	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	~fvPatchField ()=default
	Destructor. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

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

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

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

const DimensionedField< Type, volMesh > &	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...

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 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...

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	updateWeightedCoeffs (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::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
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source 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 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...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
	Manipulate fvMatrix. 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 &)

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

Public Member Functions inherited from mappedPatchFieldBase< Type >
	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const word &fieldName, const bool setAverage, const Type average, const word &interpolationScheme)
	Construct from components. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict)
	Construct from dictionary. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict, const Field< Type > &fld)
	Construct from dictionary and initial field value. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField)
	Construct empty. More...

	mappedPatchFieldBase (const mappedPatchFieldBase< Type > &mapper)
	Construct copy. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const mappedPatchFieldBase< Type > &base)
	Construct copy, resetting patch and field. More...

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

template<class T >
const GeometricField< T, fvPatchField, volMesh > &	sampleField (const word &fieldName) const
	Field to sample. Either on my or nbr mesh. More...

const GeometricField< Type, fvPatchField, volMesh > &	sampleField () const
	Field to sample. Either on my or nbr mesh. More...

virtual tmp< Field< Type > >	mappedField () const
	Map sampleField onto *this patch. More...

virtual tmp< Field< Type > >	mappedInternalField () const
	Map internal of sampleField onto *this patch. More...

virtual tmp< scalarField >	mappedWeightField () const
	Map optional weightField onto *this patch. Default is deltaCoeffs. More...

virtual void	mappedWeightField (const word &weightFieldName, tmp< scalarField > &thisWeights, tmp< scalarField > &nbrWeights) const
	Map optional weightField (given by name) onto *this patch. More...

template<class T >
void	distribute (const word &fieldName, Field< T > &newValues) const

template<class Type2 >
const Foam::GeometricField< Type2, Foam::fvPatchField, Foam::volMesh > &	sampleField (const word &fieldName) const

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

template<class Type2 >
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 Member Functions inherited from mappedPatchFieldBase< Type >
static const mappedPatchBase &	mapper (const fvPatch &p, const DimensionedField< Type, volMesh > &iF)
	Check that patch is of correct type. More...

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

Protected Member Functions inherited from mappedPatchFieldBase< Type >
template<class T >
void	initRetrieveField (const objectRegistry &obr, const word &region, const word &patch, const labelListList &map, const word &fieldName, const Field< T > &fld) const
	Construct field from registered elements. More...

template<class T >
bool	storeAndRetrieveField (const word &fieldName, const label myComm, const labelListList &subMap, const label constructSize, const labelListList &constructMap, const labelListList &address, const scalarListList &weights, Field< T > &fld) const
	Helper : storeField and retrieveField and interpolate. Leaves fld. More...

template<class T >
void	initRetrieveField (const word &fieldName, const Field< T > &fld) const
	Initialise field to retrieve (e.g. when value read from dictionary) More...

template<class T >
void	storeField (const objectRegistry &obr, const word &region, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, const Field< T > &fld) const
	Store elements of field onto (sub) registry. More...

template<class T >
bool	retrieveField (const bool allowUnset, const objectRegistry &obr, const word &region, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, Field< T > &fld) const
	Construct field from registered elements. More...

Protected Attributes inherited from mappedPatchFieldBase< Type >
const mappedPatchBase &	mapper_
	Mapping engine. More...

const fvPatchField< Type > &	patchField_
	Underlying patch field. More...

word	fieldName_
	Name of field to sample. More...

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

const Type	average_

word	interpolationScheme_
	Interpolation scheme to use for nearestcell mode. More...

Detailed Description

template<class Type>
class Foam::mappedFixedInternalValueFvPatchField< Type >

This boundary condition maps the boundary and internal values of a neighbour patch field to the boundary and internal values of *this.

Usage

Property	Description	Required	Default
`field`	name of field to be mapped	no	this field name
`setAverage`	Use average value	no	false
`average`	Average value to use if `setAverage` = yes	partly

    <patchName>
    {
        type            mappedFixedInternalValue;
        field           T;
        setAverage      false;
        average         0;
        value           uniform 0;
    }

Note: This boundary condition can only be applied to patches that are of the mappedPolyPatch type.

See also: Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch Foam::mappedFixedValueFvPatchField

Source files

Definition at line 105 of file mappedFixedInternalValueFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedFixedInternalValueFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 36 of file mappedFixedInternalValueFvPatchField.C.

◆ mappedFixedInternalValueFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 62 of file mappedFixedInternalValueFvPatchField.C.

◆ mappedFixedInternalValueFvPatchField() [3/5]

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

Construct by mapping given.

mappedFixedInternalValueFvPatchField onto a new patch

Definition at line 48 of file mappedFixedInternalValueFvPatchField.C.

◆ mappedFixedInternalValueFvPatchField() [4/5]

mappedFixedInternalValueFvPatchField ( const mappedFixedInternalValueFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 75 of file mappedFixedInternalValueFvPatchField.C.

◆ mappedFixedInternalValueFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 86 of file mappedFixedInternalValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFixedInternalValue" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from mappedFixedValueFvPatchField< Type >.

Definition at line 150 of file mappedFixedInternalValueFvPatchField.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 mappedFixedValueFvPatchField< Type >.

Definition at line 167 of file mappedFixedInternalValueFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from mappedFixedValueFvPatchField< Type >.

Definition at line 98 of file mappedFixedInternalValueFvPatchField.C.

References Foam::abort(), mappedPatchBase::distribute(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, patchIdentifier::index(), mappedPatchBase::mode(), primitiveMesh::nFaces(), Foam::foamVersion::patch, fvPatchField< Type >::patch(), fvPatchField< Type >::patchInternalField(), mappedPatchBase::sampleMesh(), mappedPatchBase::samplePolyPatch(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mappedFixedValueFvPatchField< Type >.

Definition at line 191 of file mappedFixedInternalValueFvPatchField.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/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::mappedFixedInternalValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ mappedFixedInternalValueFvPatchField() [1/5]

◆ mappedFixedInternalValueFvPatchField() [2/5]

◆ mappedFixedInternalValueFvPatchField() [3/5]

◆ mappedFixedInternalValueFvPatchField() [4/5]

◆ mappedFixedInternalValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::mappedFixedInternalValueFvPatchField< Type >