This boundary condition maps the velocity and flux from a neighbour patch to this patch. More...

Inheritance diagram for mappedVelocityFluxFixedValueFvPatchField:

Collaboration diagram for mappedVelocityFluxFixedValueFvPatchField:

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

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

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

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

	mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &)
	Construct as copy. More...

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

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

virtual tmp< fvPatchVectorField >	clone (const DimensionedField< vector, 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 &) const
	Write. More...

Private Attributes
word	phiName_
	Name of flux field. More...

Detailed Description

This boundary condition maps the velocity and flux from a neighbour patch to this patch.

Patch usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi

Example of the boundary condition specification:

    myPatch
    {
        type            mappedVelocityFlux;
        phi             phi;
        value           uniform 0;  // place holder
    }

The underlying sample mode should be set to nearestPatchFace or nearestFace

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::fixedValueFvPatchVectorField

Source files

Definition at line 93 of file mappedVelocityFluxFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedVelocityFluxFixedValueFvPatchField() [1/5]

mappedVelocityFluxFixedValueFvPatchField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 38 of file mappedVelocityFluxFixedValueFvPatchField.C.

Referenced by mappedVelocityFluxFixedValueFvPatchField::clone().

Here is the caller graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [2/5]

mappedVelocityFluxFixedValueFvPatchField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 75 of file mappedVelocityFluxFixedValueFvPatchField.C.

References dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, mappedPatchBase::mode(), and p.

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [3/5]

mappedVelocityFluxFixedValueFvPatchField	(	const mappedVelocityFluxFixedValueFvPatchField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

mappedVelocityFluxFixedValueFvPatchField onto a new patch

Definition at line 50 of file mappedVelocityFluxFixedValueFvPatchField.C.

References dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and p.

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [4/5]

mappedVelocityFluxFixedValueFvPatchField ( const mappedVelocityFluxFixedValueFvPatchField & ptf )

Construct as copy.

Definition at line 114 of file mappedVelocityFluxFixedValueFvPatchField.C.

◆ mappedVelocityFluxFixedValueFvPatchField() [5/5]

mappedVelocityFluxFixedValueFvPatchField	(	const mappedVelocityFluxFixedValueFvPatchField &	ptf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 125 of file mappedVelocityFluxFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedVelocityFlux" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 143 of file mappedVelocityFluxFixedValueFvPatchField.H.

References mappedVelocityFluxFixedValueFvPatchField::mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 160 of file mappedVelocityFluxFixedValueFvPatchField.H.

References mappedVelocityFluxFixedValueFvPatchField::mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 137 of file mappedVelocityFluxFixedValueFvPatchField.C.

References Foam::abort(), GeometricField::boundaryField(), polyMesh::boundaryMesh(), dimensionedInternalField(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), forAll, objectRegistry::lookupObject(), mappedPatchBase::mode(), UPstream::msgType(), mappedPatchBase::NEARESTFACE, mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, primitiveMesh::nFaces(), Foam::nl, Foam::operator==(), fvPatchField::patch(), mappedVelocityFluxFixedValueFvPatchField::phiName_, mappedPatchBase::sampleMesh(), mappedPatchBase::samplePatch(), fvPatch::start(), and Vector< scalar >::zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 230 of file mappedVelocityFluxFixedValueFvPatchField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ phiName_

word phiName_

private

Name of flux field.

Definition at line 100 of file mappedVelocityFluxFixedValueFvPatchField.H.

Referenced by mappedVelocityFluxFixedValueFvPatchField::updateCoeffs().

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

src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mappedVelocityFluxFixedValueFvPatchField() [1/5]

◆ mappedVelocityFluxFixedValueFvPatchField() [2/5]

◆ mappedVelocityFluxFixedValueFvPatchField() [3/5]

◆ mappedVelocityFluxFixedValueFvPatchField() [4/5]

◆ mappedVelocityFluxFixedValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Field Documentation

◆ phiName_