prghPermeableAlphaTotalPressureFvPatchScalarField Class Reference

The prghPermeableAlphaTotalPressure is a mixed boundary condition for the p_rgh variable in multiphase flows. More...

Inheritance diagram for prghPermeableAlphaTotalPressureFvPatchScalarField:

Collaboration diagram for prghPermeableAlphaTotalPressureFvPatchScalarField:

Public Member Functions
	TypeName ("prghPermeableAlphaTotalPressure")
	Runtime type information. More...
	prghPermeableAlphaTotalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...
	prghPermeableAlphaTotalPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &)
	Construct as copy. More...
virtual tmp< fvPatchField< scalar > >	clone () const
	Construct and return a clone. More...
	prghPermeableAlphaTotalPressureFvPatchScalarField (const prghPermeableAlphaTotalPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...
virtual void	updateSnGrad (const scalarField &snGradp)
	Update the patch pressure gradient field from the given snGradp. More...
virtual void	write (Ostream &) const
	Write. More...
Public Member Functions inherited from mixedFvPatchField< scalar >
	TypeName ("mixed")
	Runtime type information. More...
	mixedFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...
	mixedFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	mixedFvPatchField (const mixedFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given mixedFvPatchField onto a new patch. More...
	mixedFvPatchField (const mixedFvPatchField< scalar > &)
	Construct as copy. More...
	mixedFvPatchField (const mixedFvPatchField< scalar > &, const DimensionedField< scalar, 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 Field< scalar > &	refValue ()
virtual const Field< scalar > &	refValue () const
virtual Field< scalar > &	refGrad ()
virtual const Field< scalar > &	refGrad () const
virtual scalarField &	valueFraction ()
virtual const scalarField &	valueFraction () const
virtual Field< scalar > &	source ()
virtual const Field< scalar > &	source () const
virtual tmp< Field< scalar > >	snGrad () const
	Return gradient at boundary. More...
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. More...
virtual tmp< Field< scalar > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...
virtual void	operator= (const UList< scalar > &)
virtual void	operator= (const fvPatchField< scalar > &)
virtual void	operator= (const scalar &)
virtual void	operator+= (const fvPatchField< scalar > &)
virtual void	operator+= (const Field< scalar > &)
virtual void	operator+= (const scalar &)
virtual void	operator-= (const fvPatchField< scalar > &)
virtual void	operator-= (const Field< scalar > &)
virtual void	operator-= (const scalar &)
virtual void	operator*= (const fvPatchField< scalar > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const fvPatchField< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator/= (const scalar)
Public Member Functions inherited from fvPatchField< scalar >
	TypeName ("fvPatchField")
	Runtime type information. More...
	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< scalar, volMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< scalar > &ptf, const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const dictionary &dict),(p, iF, dict))
	fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...
	fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const scalar &value)
	Construct from patch, internal field and value. More...
	fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...
	fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const Field< scalar > &)
	Construct from patch and internal field and patch field. More...
	fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...
	fvPatchField (const fvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...
	fvPatchField (const fvPatchField< scalar > &)
	Construct as copy. More...
	fvPatchField (const fvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...
Foam::tmp< Foam::fvPatchField< scalar > >	NewCalculatedType (const fvPatchField< Type2 > &pf)
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< scalar, volMesh > &	internalField () const
	Return dimensioned internal field reference. More...
const Field< scalar > &	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 tmp< Field< scalar > >	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< scalar > >	patchInternalField () const
	Return internal field next to patch as patch field. More...
virtual void	patchInternalField (Field< scalar > &) const
	Return internal field next to patch as patch field. More...
virtual tmp< Field< scalar > >	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 tmp< Field< scalar > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...
virtual tmp< Field< scalar > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...
virtual void	manipulateMatrix (fvMatrix< scalar > &matrix)
	Manipulate matrix. More...
virtual void	manipulateMatrix (fvMatrix< scalar > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...
virtual void	manipulateMatrix (fvMatrix< scalar > &matrix, const label iMatrix, const direction cmp)
	Manipulate fvMatrix. More...
void	check (const fvPatchField< scalar > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...
virtual void	operator== (const fvPatchField< scalar > &)
virtual void	operator== (const Field< scalar > &)
virtual void	operator== (const scalar &)
Public Member Functions inherited from updateableSnGrad
	updateableSnGrad ()=default
	Constructor. More...
virtual	~updateableSnGrad ()=default
	Destructor. More...

Additional Inherited Members
Public Types inherited from fvPatchField< scalar >
typedef fvPatch	Patch
typedef calculatedFvPatchField< scalar >	Calculated
Static Public Member Functions inherited from fvPatchField< scalar >
static tmp< fvPatchField< scalar > >	New (const word &, const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...
static tmp< fvPatchField< scalar > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...
static tmp< fvPatchField< scalar > >	New (const fvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...
static tmp< fvPatchField< scalar > >	New (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...
static tmp< fvPatchField< scalar > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...
static tmp< fvPatchField< scalar > >	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< scalar >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

The prghPermeableAlphaTotalPressure is a mixed boundary condition for the p_rgh variable in multiphase flows.

It switches between an open boundary using the prghTotalPressure boundary condition and a wall condition using the fixedFluxPressure boundary condition.

In the prghPermeableAlphaTotalPressure, an open condition is applied when alpha is under a user-defined alphaMin value and a wall condition is applied when alpha is larger than the alphaMin.

This boundary condition can be used in conjunction with pressurePermeableAlphaInletOutletVelocity for the U variable.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            prghPermeableAlphaTotalPressure;
    p               uniform 0;

    // Optional entries
    phi             phi;
    rho             rho;
    U               U;
    alphaName       alpha.water;
    alphaMin        0.01;

    // Inherited entries
    value           uniform 0;
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
p	Total pressure	PatchFunction1<scalar>	yes	-
phi	Name of flux field	word	no	phi
rho	Name of density field	word	no	rho
U	Name of velocity field	word	no	U
alpha	Name of mixture field	word	no	none
alphaMin	Minimum alpha	scalar	no	1

The inherited entries are elaborated in:

• mixedFvPatchFields.H
• PatchFunction1.H

See also

• Foam::pressurePermeableAlphaInletOutletVelocityFvPatchVectorField
• Foam::mixedFvPatchVectorField
• Foam::prghTotalPressureFvPatchScalarField

Source files

• prghPermeableAlphaTotalPressureFvPatchScalarField.H
• prghPermeableAlphaTotalPressureFvPatchScalarField.C

Definition at line 150 of file prghPermeableAlphaTotalPressureFvPatchScalarField.H.

Constructor & Destructor Documentation

prghPermeableAlphaTotalPressureFvPatchScalarField() [1/5]

prghPermeableAlphaTotalPressureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 37 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

Referenced by prghPermeableAlphaTotalPressureFvPatchScalarField::clone().

Here is the caller graph for this function:

prghPermeableAlphaTotalPressureFvPatchScalarField() [2/5]

prghPermeableAlphaTotalPressureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 59 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References dict, and p.

prghPermeableAlphaTotalPressureFvPatchScalarField() [3/5]

prghPermeableAlphaTotalPressureFvPatchScalarField	(	const prghPermeableAlphaTotalPressureFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given prghPermeableAlphaTotalPressureFvPatchScalarField onto a new patch

Definition at line 94 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

prghPermeableAlphaTotalPressureFvPatchScalarField() [4/5]

prghPermeableAlphaTotalPressureFvPatchScalarField

(

const prghPermeableAlphaTotalPressureFvPatchScalarField &

tppsf

)

Construct as copy.

Definition at line 114 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

prghPermeableAlphaTotalPressureFvPatchScalarField() [5/5]

prghPermeableAlphaTotalPressureFvPatchScalarField	(	const prghPermeableAlphaTotalPressureFvPatchScalarField &	tppsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 131 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

Member Function Documentation

TypeName()

TypeName

(

"prghPermeableAlphaTotalPressure"

)

Runtime type information.

clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 220 of file prghPermeableAlphaTotalPressureFvPatchScalarField.H.

References prghPermeableAlphaTotalPressureFvPatchScalarField::prghPermeableAlphaTotalPressureFvPatchScalarField().

Here is the call graph for this function:

clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 238 of file prghPermeableAlphaTotalPressureFvPatchScalarField.H.

References prghPermeableAlphaTotalPressureFvPatchScalarField::prghPermeableAlphaTotalPressureFvPatchScalarField().

Here is the call graph for this function:

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

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

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 150 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

rmap()

void rmap ( const fvPatchScalarField &  ptf, const labelList &  addr  )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 164 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< scalar >.

Definition at line 251 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References fvPatchField< scalar >::db(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, timeIndex, and fvPatchField< scalar >::updated().

Here is the call graph for this function:

updateSnGrad()

void updateSnGrad ( const scalarField &  snGradp )

virtual

Update the patch pressure gradient field from the given snGradp.

Implements updateableSnGrad.

Definition at line 182 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References Foam::cmptMag(), Foam::expressions::patchExpr::debug, Foam::dimLength, Foam::endl(), g, Foam::gSum(), Foam::Info, Foam::mag(), Foam::magSqr(), Foam::New(), p, Foam::foamVersion::patch, phi, Foam::pos(), and Foam::pos0().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< scalar >.

Definition at line 269 of file prghPermeableAlphaTotalPressureFvPatchScalarField.C.

References os(), mixedFvPatchField< Type >::write(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

---

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

• src/finiteVolume/fields/fvPatchFields/derived/prghPermeableAlphaTotalPressure/prghPermeableAlphaTotalPressureFvPatchScalarField.H
• src/finiteVolume/fields/fvPatchFields/derived/prghPermeableAlphaTotalPressure/prghPermeableAlphaTotalPressureFvPatchScalarField.C