This boundary condition provides an advective outflow condition, based on solving DDt(W, field) = 0 at the boundary where W is the wave velocity and field is the field to which this boundary condition is applied. More...

Inheritance diagram for advectiveFvPatchField< Type >:

[legend]

Collaboration diagram for advectiveFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("advective")

	advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	advectiveFvPatchField (const advectiveFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	advectiveFvPatchField (const advectiveFvPatchField &)

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

	advectiveFvPatchField (const advectiveFvPatchField &, const DimensionedField< Type, volMesh > &)

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

const Type &	fieldInf () const

Type &	fieldInf ()

scalar	lInf () const

scalar &	lInf ()

virtual tmp< scalarField >	advectionSpeed () const

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

Public Member Functions inherited from mixedFvPatchField< Type >
	TypeName ("mixed")

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	mixedFvPatchField (const mixedFvPatchField< Type > &)

	mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

virtual Field< Type > &	source ()

virtual const Field< Type > &	source () const

virtual void	autoMap (const fvPatchFieldMapper &)

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

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

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

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

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

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

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

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

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

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

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

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual void	updateWeightedCoeffs (const scalarField &weights)

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

virtual void	patchInternalField (Field< Type > &) const

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

virtual void	initEvaluate (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 > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

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

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

void	check (const fvPatchField< Type > &) const

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

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

virtual void	operator== (const Type &)

Protected Attributes
word	phiName_

word	rhoName_

Type	fieldInf_

scalar	lInf_

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

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

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

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::advectiveFvPatchField< Type >

This boundary condition provides an advective outflow condition, based on solving DDt(W, field) = 0 at the boundary where W is the wave velocity and field is the field to which this boundary condition is applied.

The standard (Euler, backward, CrankNicolson, localEuler) time schemes are supported. Additionally an optional mechanism to relax the value at the boundary to a specified far-field value is provided which is switched on by specifying the relaxation length-scale lInf and the far-field value fieldInf.

The flow/wave speed (w) at the outlet is provided by the virtual function advectionSpeed() the default implementation of which requires the name of the flux field (phi) and optionally the density (rho) if the mass-flux rather than the volumetric-flux is given.

The flow/wave speed at the outlet can be changed by deriving a specialised BC from this class and over-riding advectionSpeed() e.g. in waveTransmissiveFvPatchField the advectionSpeed() calculates and returns the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition.

Usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`fieldInf`	value of field beyond patch	no
`lInf`	distance beyond patch for `fieldInf`	no

Example of the boundary condition specification:

    <patchName>
    {
        type            advective;
        phi             phi;
    }

Note: If lInf is specified, fieldInf will be required; rho is only required in the case of a mass-based flux.

Source files

Definition at line 116 of file advectiveFvPatchField.H.

Constructor & Destructor Documentation

◆ advectiveFvPatchField() [1/5]

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

Definition at line 36 of file advectiveFvPatchField.C.

References Foam::Zero.

◆ advectiveFvPatchField() [2/5]

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

Definition at line 72 of file advectiveFvPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), Foam::nl, fvPatchField::operator=(), p, Foam::foamVersion::patch, dictionary::readEntry(), dictionary::readIfPresent(), and Foam::Zero.

Here is the call graph for this function:

◆ advectiveFvPatchField() [3/5]

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	,
		const fvPatch &	,
		const DimensionedField< Type, volMesh > &	,
		const fvPatchFieldMapper &
	)

◆ advectiveFvPatchField() [4/5]

advectiveFvPatchField ( const advectiveFvPatchField< Type > & ptpsf )

Definition at line 119 of file advectiveFvPatchField.C.

◆ advectiveFvPatchField() [5/5]

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	ptpsf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 133 of file advectiveFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "advective" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 178 of file advectiveFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 195 of file advectiveFvPatchField.H.

◆ fieldInf() [1/2]

const Type& fieldInf ( ) const

inline

Definition at line 211 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

◆ fieldInf() [2/2]

Type& fieldInf ( )

inline

Definition at line 217 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

◆ lInf() [1/2]

scalar lInf ( ) const

inline

Definition at line 223 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::lInf_.

◆ lInf() [2/2]

scalar& lInf ( )

inline

Definition at line 230 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::lInf_.

◆ advectionSpeed()

Foam::tmp< Foam::scalarField > advectionSpeed

virtual

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 150 of file advectiveFvPatchField.C.

References Foam::dimArea, Foam::dimDensity, Foam::dimVelocity, Foam::foamVersion::patch, and phi.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 180 of file advectiveFvPatchField.C.

References Foam::constant::atomic::alpha, GeometricField::boundaryField(), schemesLookup::ddtScheme(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, field(), k, localEulerDdt::localRDeltaT(), Foam::max(), mesh, Foam::nl, Foam::foamVersion::patch, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >, and acousticWaveTransmissiveFvPatchField< Type >.

Definition at line 332 of file advectiveFvPatchField.C.

References os(), fvPatchField::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

Member Data Documentation

◆ phiName_

word phiName_

protected

Definition at line 125 of file advectiveFvPatchField.H.

◆ rhoName_

word rhoName_

protected

Definition at line 129 of file advectiveFvPatchField.H.

◆ fieldInf_

Type fieldInf_

protected

Definition at line 132 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::fieldInf().

◆ lInf_

scalar lInf_

protected

Definition at line 135 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::lInf().

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

src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::advectiveFvPatchField< Type >

Constructor & Destructor Documentation

◆ advectiveFvPatchField() [1/5]

◆ advectiveFvPatchField() [2/5]

◆ advectiveFvPatchField() [3/5]

◆ advectiveFvPatchField() [4/5]

◆ advectiveFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fieldInf() [1/2]

◆ fieldInf() [2/2]

◆ lInf() [1/2]

◆ lInf() [2/2]

◆ advectionSpeed()

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ phiName_

◆ rhoName_

◆ fieldInf_

◆ lInf_

template<class Type>
class Foam::advectiveFvPatchField< Type >