Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area. More...

Inheritance diagram for mappedFlowRateFvPatchVectorField:

[legend]

Collaboration diagram for mappedFlowRateFvPatchVectorField:

[legend]

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

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

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

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

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

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

	mappedFlowRateFvPatchVectorField (const mappedFlowRateFvPatchVectorField &, 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...

Detailed Description

Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area.

The inlet mass flux is taken from the neighbour region.

The basis of the patch (volumetric or mass) is determined by the dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis.

Usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`neigPhi`	name of flux field on neighbour mesh	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            mappedFlowRate;
        phi             phi;
        rho             rho;
        neigPhi         phi;
        value           uniform (0 0 0); // placeholder
    }

Source files

Definition at line 97 of file mappedFlowRateFvPatchVectorField.H.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 36 of file mappedFlowRateFvPatchVectorField.C.

Referenced by mappedFlowRateFvPatchVectorField::clone(), and mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 64 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

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

Construct by mapping given.

mappedFlowRateFvPatchVectorField onto a new patch

Definition at line 49 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

mappedFlowRateFvPatchVectorField ( const mappedFlowRateFvPatchVectorField & ptf )

Construct as copy.

Definition at line 78 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

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

Construct as copy setting internal field reference.

Definition at line 90 of file mappedFlowRateFvPatchVectorField.C.

Member Function Documentation

TypeName ( "mappedFlowRate" )

Runtime type information.

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 154 of file mappedFlowRateFvPatchVectorField.H.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 171 of file mappedFlowRateFvPatchVectorField.H.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField(), mappedFlowRateFvPatchVectorField::updateCoeffs(), and mappedFlowRateFvPatchVectorField::write().

Here is the call graph for this function:

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 104 of file mappedFlowRateFvPatchVectorField.C.

References boundary(), Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, mappedPatchBase::distribute(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), patchIdentifier::index(), Foam::Info, fvPatch::lookupPatchField(), UPstream::msgType(), n, fvPatch::name(), Foam::nl, Foam::operator==(), phi, mappedPatchBase::sampleMesh(), mappedPatchBase::samplePolyPatch(), U, fvPatchField< Type >::updateCoeffs(), and mappedFlowRateFvPatchVectorField::write().

Referenced by mappedFlowRateFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream & os ) const

virtual

Write.

Definition at line 184 of file mappedFlowRateFvPatchVectorField.C.

References token::END_STATEMENT, Foam::makePatchTypeField(), Foam::nl, and fvPatchField< Type >::write().

Referenced by mappedFlowRateFvPatchVectorField::clone(), and mappedFlowRateFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation