Loading...
Searching...
No Matches
porousBafflePressureFvPatchField Class Reference

This boundary condition provides a jump condition, using the cyclic condition as a base. More...

#include <porousBafflePressureFvPatchField.H>

Inheritance diagram for porousBafflePressureFvPatchField:
Collaboration diagram for porousBafflePressureFvPatchField:

Public Member Functions

 TypeName ("porousBafflePressure")
 Runtime type information.
 porousBafflePressureFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
 porousBafflePressureFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &, const bool needValue=true)
 Construct from patch, internal field and dictionary.
 porousBafflePressureFvPatchField (const porousBafflePressureFvPatchField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given porousBafflePressureFvPatchField onto a new patch.
 porousBafflePressureFvPatchField (const porousBafflePressureFvPatchField &)
 Construct as copy.
 porousBafflePressureFvPatchField (const porousBafflePressureFvPatchField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > > clone () const
 Return a clone.
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Clone with an internal field reference.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.
Public Member Functions inherited from fixedJumpFvPatchField< scalar >
 TypeName ("fixedJump")
 Runtime type information.
 fixedJumpFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
virtual void setJump (const Field< scalar > &jump)
 Set the jump field.
virtual tmp< Field< scalar > > jump () const
 Return the "jump" across the patch.
virtual tmp< Field< scalar > > jump0 () const
 Return the old time "jump" across the patch.
virtual scalar relaxFactor () const
 Return the under-relaxation factor.
virtual void relax ()
 Return the relaxed "jump" across the patch.
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchField< scalar > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
Public Member Functions inherited from jumpCyclicFvPatchField< scalar >
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality.
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality.
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
 Update result field based on interface functionality.
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes) const
 Update result field based on interface functionality.
 TypeName ("jumpCyclic")
 Runtime type information.
 jumpCyclicFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
virtual const wordinterfaceFieldType () const
 Return the interface type.
virtual tmp< Field< scalar > > patchNeighbourField () const
 Return neighbour coupled values.
Public Member Functions inherited from cyclicFvPatchField< scalar >
 TypeName (cyclicFvPatch::typeName_())
 Runtime type information.
 cyclicFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
const cyclicFvPatchcyclicPatch () const
 Return local reference cast into the cyclic patch.
const cyclicFvPatchField< scalar > & neighbourPatchField () const
 Return reference to neighbour patchField.
virtual void manipulateMatrix (fvMatrix< scalar > &m, const label iMatrix, const direction cmp)
 Manipulate matrix.
virtual bool doTransform () const
 Does the patch field perform the transformation.
virtual const tensorFieldforwardT () const
 Return face transformation tensor.
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor.
virtual int rank () const
 Return rank of component for transform.
Public Member Functions inherited from cyclicLduInterfaceField
 TypeName ("cyclicLduInterfaceField")
 Runtime type information.
 cyclicLduInterfaceField ()=default
 Construct null.
virtual ~cyclicLduInterfaceField ()=default
 Destructor.
template<class Type>
void transformCoupleField (Field< Type > &f) const
 Transform given patch field.
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component field.
Public Member Functions inherited from coupledFvPatchField< scalar >
 TypeName (coupledFvPatch::typeName_())
 Runtime type information.
 coupledFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
virtual bool coupled () const
 True if this patch field is derived from coupledFvPatchField.
virtual tmp< Field< scalar > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient.
virtual void initEvaluate (const Pstream::commsTypes commsType)
 Initialise the evaluation of the patch field.
virtual void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field.
virtual void initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
 Initialise the evaluation of the patch field after a local.
virtual void evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
 Evaluate the patch field after a local operation (e.g. *=).
virtual tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual tmp< Field< scalar > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField.
virtual tmp< Field< scalar > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField.
Public Member Functions inherited from LduInterfaceField< scalar >
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Inherit initInterfaceMatrixUpdate from lduInterfaceField.
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const =0
 Inherit updateInterfaceMatrix from lduInterfaceField.
 TypeName ("LduInterfaceField")
 Runtime type information.
virtual ~LduInterfaceField ()=default
 Destructor.
Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information.
 lduInterfaceField (const lduInterfaceField &)=delete
 No copy construct.
void operator= (const lduInterfaceField &)=delete
 No copy assignment.
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch.
virtual ~lduInterfaceField ()=default
 Destructor.
const lduInterfaceinterface () const noexcept
 Return the interface.
virtual bool ready () const
 Are all (receive) data available?
bool updatedMatrix () const noexcept
 Whether matrix has been updated.
bool updatedMatrix (bool flag) const noexcept
 Set matrix as update-to-date, return the previous value.
template<class Type>
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field.
bool & updatedMatrix () noexcept
 Adjust whether matrix has been updated.
Public Member Functions inherited from fvPatchField< scalar >
 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.
 fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const word &patchType)
 Construct from patch, internal field and patch type.
 fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const scalar &value)
 Construct from patch, internal field and value.
 fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const Field< scalar > &pfld)
 Construct from patch, internal field and patch field.
 fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, Field< scalar > &&pfld)
 Construct from patch, internal field and patch field.
 fvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &dict, IOobjectOption::readOption requireValue=IOobjectOption::MUST_READ)
 Construct from patch, internal field and dictionary.
 fvPatchField (const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const dictionary &dict, const bool needValue)
 Construct, forwarding to readOption variant.
 fvPatchField (const fvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch.
 fvPatchField (const fvPatchField< scalar > &pfld, const fvPatch &p, const DimensionedField< scalar, volMesh > &iF, const scalar &value)
 Copy construct onto a new patch with internal field reference and specified value.
 fvPatchField (const fvPatchField< scalar > &pfld, const DimensionedField< scalar, volMesh > &iF)
 Copy construct with internal field reference.
 fvPatchField (const fvPatchField< scalar > &pfld)
 Copy construct.
virtual ~fvPatchField ()=default
 Destructor.
const DimensionedField< scalar, volMesh > & internalField () const noexcept
 Return const-reference to the dimensioned internal field.
const Field< scalar > & primitiveField () const noexcept
 Return const-reference to the internal field values.
virtual void rmap (const fvPatchField< scalar > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual tmp< Field< scalar > > snGrad () const
 Return patch-normal gradient.
virtual void snGrad (UList< scalar > &result) const
 Retrieve patch-normal gradient [contiguous storage].
virtual void snGrad (const scalarField &deltaCoeffs, UList< scalar > &) const
 Retrieve patch-normal gradient for coupled-patches using the deltaCoeffs provided [contiguous storage].
virtual tmp< Field< scalar > > patchInternalField () const
 Return internal field next to patch.
virtual void patchInternalField (UList< scalar > &pfld) const
 Retrieve internal field next to patch.
virtual void patchNeighbourField (UList< scalar > &) const
 Retrieve patchField on the opposite patch of a coupled patch.
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field.
virtual tmp< Field< scalar > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField.
virtual tmp< Field< scalar > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField.
virtual void manipulateMatrix (fvMatrix< scalar > &matrix)
 Manipulate matrix.
virtual void manipulateMatrix (fvMatrix< scalar > &matrix, const scalarField &weights)
 Manipulate matrix with given weights.
virtual void manipulateMatrix (fvMatrix< scalar > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix.
virtual void valueInternalCoeffs (const tmp< Field< scalar > > &, UList< scalar > &) const
 Retrieve the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual void valueBoundaryCoeffs (const tmp< Field< scalar > > &, UList< scalar > &) const
 Retrieve the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual void gradientInternalCoeffs (UList< scalar > &) const
 Retrieve the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField.
virtual void gradientInternalCoeffs (const scalarField &deltaCoeffs, UList< scalar > &) const
 Retrieve the matrix diagonal coefficients corresponding to the evaluation of the gradient of this coupled patchField using the deltaCoeffs provided.
virtual void gradientBoundaryCoeffs (UList< scalar > &) const
 Retrieve the matrix source coefficients corresponding to the evaluation of the gradient of this patchField.
virtual void gradientBoundaryCoeffs (const scalarField &deltaCoeffs, UList< scalar > &) const
 Retrieve the matrix source coefficients corresponding to the evaluation of the gradient of this coupled patchField using the deltaCoeffs provided.
void check (const fvPatchField< scalar > &) const
 Check against given patch field.
virtual void operator= (const UList< scalar > &)
virtual void operator= (const fvPatchField< scalar > &)
virtual void operator+= (const fvPatchField< scalar > &)
virtual void operator-= (const fvPatchField< scalar > &)
virtual void operator*= (const fvPatchField< scalar > &)
virtual void operator/= (const fvPatchField< scalar > &)
virtual void operator+= (const Field< scalar > &)
virtual void operator-= (const Field< scalar > &)
virtual void operator*= (const Field< scalar > &)
virtual void operator/= (const Field< scalar > &)
virtual void operator= (const scalar &)
virtual void operator+= (const scalar &)
virtual void operator-= (const scalar &)
virtual void operator*= (const scalar)
virtual void operator/= (const scalar)
virtual void operator== (const fvPatchField< scalar > &)
virtual void operator== (const Field< scalar > &)
virtual void operator== (const scalar &)
bool operator!= (const fvPatchField< scalar > &) const=delete
bool operator!= (const Field< scalar > &) const=delete
bool operator!= (const scalar &) const=delete
Foam::tmp< Foam::fvPatchField< scalar > > NewCalculatedType (const fvPatchField< AnyType > &pf)
Public Member Functions inherited from fvPatchFieldBase
 TypeName ("fvPatchField")
 Runtime type information.
 fvPatchFieldBase (const fvPatch &p)
 Construct from patch.
 fvPatchFieldBase (const fvPatch &p, const word &patchType)
 Construct from patch and patch type.
 fvPatchFieldBase (const fvPatch &p, const dictionary &dict)
 Construct from patch and dictionary.
 fvPatchFieldBase (const fvPatchFieldBase &rhs, const fvPatch &p)
 Copy construct with new patch.
 fvPatchFieldBase (const fvPatchFieldBase &rhs)
 Copy construct.
virtual ~fvPatchFieldBase ()=default
 Destructor.
virtual bool assignable () const
 True if the value of the patch field is altered by assignment.
virtual bool fixesValue () const
 True if the patch field fixes a value.
const objectRegistrydb () const
 The associated objectRegistry.
const fvPatchpatch () const noexcept
 Return the patch.
const wordpatchType () const noexcept
 The optional patch type.
wordpatchType () noexcept
 The optional patch type.
virtual bool constraintOverride () const
 True if the type does not correspond to the constraint type.
bool updated () const noexcept
 True if the boundary condition has already been updated.
void setUpdated (bool state) noexcept
 Set updated state.
bool manipulatedMatrix () const noexcept
 True if the matrix has already been manipulated.
void setManipulated (bool state) noexcept
 Set matrix manipulated state.
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only.
bool useImplicit (bool on) noexcept
 Set useImplicit on/off.
void checkPatch (const fvPatchFieldBase &rhs) const
 Check that patches are identical.
Public Member Functions inherited from Field< scalar >
constexpr Field () noexcept
 Default construct.
 Field (const label len)
 Construct given size.
 Field (const label len, const scalar &val)
 Construct given size and initial value.
 Field (const label len, Foam::zero)
 Construct given size and initial values of zero.
 Field (Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content.
 Field (Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content.
 Field (Foam::one, Foam::zero)
 Construct with length=1, initializing content to zero.
 Field (const Field< scalar > &fld)
 Copy construct.
 Field (const UList< scalar > &list)
 Copy construct from UList<Type>.
 Field (const IndirectListBase< scalar, Addr > &list)
 Copy construct from IndirectList.
 Field (Field< scalar > &&fld) noexcept
 Move construct from Field.
 Field (List< scalar > &&list) noexcept
 Move construct from List.
 Field (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList.
 Field (const UList< scalar > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field.
 Field (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field.
 Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field.
 Field (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field.
 Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field.
 Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field.
 Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field.
 Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field.
 Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items.
 Field (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied values for unmapped items.
 Field (Field< scalar > &fld, bool reuse)
 Copy construct or re-use as specified.
 Field (const tmp< Field< scalar > > &tfld)
 Copy or move construct from tmp.
 Field (Istream &is)
 Construct from Istream.
 Field (const entry &e, const label len)
 Construct from a dictionary (primitive) entry.
 Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign():
tmp< Field< scalar > > clone () const
 Clone.
void assign (const entry &e, const label len)
 Assign from a primitive dictionary entry with the following behaviour:
bool assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above).
void map (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field
void map (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field
void map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field.
void map (const tmp< Field< scalar > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field.
void map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field.
void map (const tmp< Field< scalar > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field.
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self.
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field
void rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field.
void rmap (const tmp< Field< scalar > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field.
void negate ()
 Inplace negate this field (negative).
void normalise ()
 Inplace normalise this field. Generally a no-op except for vector fields.
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field.
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field.
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field.
void replace (const direction, const cmptType &)
 Replace a component field of the field.
void clamp_min (const scalar &lower)
 Impose lower (floor) clamp on the field values (in-place).
void clamp_min (const UList< scalar > &lower)
 Impose lower (floor) clamp on the field values (in-place).
void clamp_max (const scalar &upper)
 Impose upper (ceiling) clamp on the field values (in-place).
void clamp_max (const UList< scalar > &upper)
 Impose upper (ceiling) clamp on the field values (in-place).
void clamp_range (const scalar &lower, const scalar &upper)
 Clamp field values (in-place) to the specified range.
void clamp_range (const MinMax< scalar > &range)
 Clamp field values (in-place) to the specified range.
VSForm block (const label start) const
tmp< Field< scalar > > T () const
 Return the field transpose (only defined for second rank tensors).
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry.
SubField< scalar > slice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking.
const SubField< scalar > slice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking.
SubField< scalar > slice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking.
const SubField< scalar > slice (const labelRange &range) const
 Return SubField slice (const access) - with range checking.
void operator= (const Field< scalar > &)
 Copy assignment.
void operator= (const tmp< Field< scalar > > &)
void operator= (const UList< scalar > &rhs)
void operator= (const SubField< scalar > &rhs)
void operator= (const IndirectListBase< scalar, Addr > &rhs)
 Copy assign from IndirectList.
void operator= (Field< scalar > &&rhs)
 Move assignment.
void operator= (List< scalar > &&rhs)
void operator= (DynamicList< scalar, SizeMin > &&rhs)
void operator= (const scalar &val)
 Assign entries to the given value.
void operator= (Foam::zero)
 Assign entries to zero.
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void operator+= (const UList< scalar > &)
void operator+= (const tmp< Field< scalar > > &)
void operator-= (const UList< scalar > &)
void operator-= (const tmp< Field< scalar > > &)
void operator*= (const UList< scalar > &)
void operator*= (const tmp< Field< scalar > > &)
void operator/= (const UList< scalar > &)
void operator/= (const tmp< Field< scalar > > &)
void operator+= (const scalar &)
void operator-= (const scalar &)
void operator*= (const scalar &)
void operator/= (const scalar &)
 Field (const Expression::ListExpression< E > &expr)
 Construct from value expression.
void operator= (const Expression::ListExpression< E > &expr)
 Assign values from expression.
void operator= (const tmp< Field > &rhs)
void normalise ()
void normalise ()
void normalise ()
 Inplace normalise (float) vector field.
void normalise ()
 Inplace normalise (double) vector field.
Public Member Functions inherited from FieldBase
constexpr FieldBase () noexcept
 Default construct.
Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0.
int use_count () const noexcept
 Return the current reference count.
bool unique () const noexcept
 Return true if the reference count is zero.
void operator++ () noexcept
 Increment the reference count.
void operator++ (int) noexcept
 Increment the reference count.
void operator-- () noexcept
 Decrement the reference count.
void operator-- (int) noexcept
 Decrement the reference count.
Public Member Functions inherited from List< scalar >
constexpr List () noexcept
 Default construct.
 List (const label len)
 Construct with given size.
 List (const label len, const scalar &val)
 Construct with given size and value for all elements.
 List (const label len, Foam::zero)
 Construct with given size initializing all elements to zero.
 List (Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content.
 List (Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content.
 List (Foam::one, Foam::zero)
 Construct with length=1, initializing content to zero.
 List (const List< scalar > &list)
 Copy construct from list.
 List (const UList< scalar > &list)
 Copy construct contents from list.
 List (List< scalar > &list, bool reuse)
 Construct as copy or re-use as specified.
 List (const UList< scalar > &list, const labelUList &indices)
 Copy construct subset of list.
 List (const UList< scalar > &list, const FixedList< label, N > &indices)
 Copy construct subset of list.
 List (const FixedList< scalar, N > &list)
 Construct as copy of FixedList<T, N>.
 List (const UPtrList< scalar > &list)
 Construct as copy of UPtrList<T> content.
 List (const IndirectListBase< scalar, Addr > &list)
 Construct as copy of IndirectList contents.
 List (std::initializer_list< scalar > list)
 Construct from an initializer list.
 List (List< scalar > &&list) noexcept
 Move construct from List.
 List (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList.
 List (Istream &is)
 Construct from Istream.
autoPtr< List< scalar > > clone () const
 Clone.
 ~List ()
 Destructor.
void clear ()
 Clear the list, i.e. set size to zero.
void resize (const label len)
 Adjust allocated size of list.
void resize (const label len, const scalar &val)
 Adjust allocated size of list and set val for new elements.
void resize_copy (label count, const label len)
 Change allocated size of list, retaining the first count elements.
void resize_fill (const label len, const scalar &val)
 Adjust allocated size of list and set val for all elements.
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily.
void transfer (List< scalar > &list)
 Transfer the contents of the argument List into this list and annul the argument list.
void transfer (DynamicList< scalar, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list.
scalar & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required.
scalar & emplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element.
void push_back (const scalar &val)
 Append an element at the end of the list.
void push_back (scalar &&val)
 Move append an element at the end of the list.
void push_back (const UList< scalar > &list)
 Append a List to the end of this list.
void push_back (const IndirectListBase< scalar, Addr > &list)
 Append IndirectList contents at the end of this list.
label push_uniq (const scalar &val)
 Append an element if not already in the list.
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list.
void operator= (const UList< scalar > &list)
 Assignment to UList operator. Takes linear time.
void operator= (const List< scalar > &list)
 Assignment operator. Takes linear time.
void operator= (const IndirectListBase< scalar, Addr > &list)
 Assignment from IndirectList. Takes linear time.
void operator= (const FixedList< scalar, N > &list)
 Copy assignment from FixedList.
void operator= (std::initializer_list< scalar > list)
 Assignment to an initializer list.
void operator= (const scalar &val)
 Assignment of all entries to the given value.
void operator= (Foam::zero)
 Assignment of all entries to zero.
void operator= (List< scalar > &&list)
 Move assignment. Takes constant time.
void operator= (DynamicList< scalar, SizeMin > &&list)
 Move assignment. Takes constant time.
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List.
void shallowCopy (const UList< scalar > &)=delete
 No shallowCopy permitted.
bool set (const label i, bool val=true)
 A bitSet::set() method for a list of bool.
void append (const scalar &val)
 Append an element at the end of the list.
void append (scalar &&val)
 Move append an element at the end of the list.
void append (const UList< scalar > &list)
 Append a List to the end of this list.
void append (const IndirectListBase< scalar, Addr > &list)
 Append IndirectList contents at the end of this list.
label appendUniq (const scalar &val)
 Same as push_uniq().
void setSize (label n)
 Alias for resize().
void setSize (label n, const scalar &val)
 Alias for resize().
 List (const Expression::ListExpression< E > &expr)
 Construct from value expression.
void operator= (const Expression::ListExpression< E > &expr)
 Assign values from expression.
void resize (const label len)
Public Member Functions inherited from UList< scalar >
 UList (const UList< scalar > &) noexcept=default
 Copy construct, shallow copy.
 UList (UList< scalar > &&) noexcept=default
 Move construct, shallow copy.
UList< scalar > & operator= (const UList< scalar > &)=delete
 No copy assignment (default: shallow copy).
UList< scalar > & operator= (UList< scalar > &&) noexcept=default
 Move assignment, shallow copy.
constexpr UList () noexcept
 Default construct, zero-sized and nullptr.
 UList (scalar *__restrict__ ptr, const label len) noexcept
 Construct from components.
 UList (SubList< scalar > &&) noexcept
 Move construct from a SubList, shallow copy.
label fcIndex (const label i) const noexcept
 The forward circular index. The next index in the list which returns to the first at the end of the list.
label rcIndex (const label i) const noexcept
 The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const scalar & fcValue (const label i) const
 Return forward circular value (ie, next value in the list).
scalar & fcValue (const label i)
 Return forward circular value (ie, next value in the list).
const scalar & rcValue (const label i) const
 Return reverse circular value (ie, previous value in the list).
scalar & rcValue (const label i)
 Return reverse circular value (ie, previous value in the list).
const scalar * cdata () const noexcept
 Return pointer to the underlying array serving as data storage.
scalar * data () noexcept
 Return pointer to the underlying array serving as data storage.
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,.
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,.
scalar & front ()
 Access first element of the list, position [0].
const scalar & front () const
 Access first element of the list.
scalar & back ()
 Access last element of the list, position [size()-1].
const scalar & back () const
 Access last element of the list, position [size()-1].
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data.
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void checkStart (const label start) const
 Check start is within valid range [0,size).
void checkSize (const label size) const
 Check size is within valid range [0,size].
void checkRange (const label start, const label len) const
 Check that start and length define a valid range.
void checkIndex (const label i) const
 Check index is within valid range [0,size).
bool uniform () const
 True if all entries have identical values, and list is non-empty.
bool contains (const scalar &val) const
 True if the value is contained in the list.
bool contains (const scalar &val, label pos, label len=-1) const
 Is the value contained in the list?
label find (const scalar &val) const
 Find index of the first occurrence of the value.
label find (const scalar &val, label pos, label len=-1) const
 Find index of the first occurrence of the value.
label rfind (const scalar &val, label pos=-1) const
 Find index of the last occurrence of the value.
void moveFirst (const label i)
 Move element to the first position.
void moveLast (const label i)
 Move element to the last position.
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list.
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list.
void shallowCopy (scalar *__restrict__ ptr, const label len) noexcept
 Copy the pointer and size.
void shallowCopy (std::nullptr_t) noexcept
 Copy nullptr and zero size.
void shallowCopy (const UList< scalar > &list) noexcept
 Copy the pointer and size held by the given UList.
void deepCopy (const UList< scalar > &list)
 Copy elements of the given UList. Sizes must match!
void deepCopy (const IndirectListBase< scalar, Addr > &list)
 Copy elements of the given indirect list. Sizes must match!
SubList< scalar > slice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking.
const SubList< scalar > slice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking.
SubList< scalar > slice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking.
const SubList< scalar > slice (const labelRange &range) const
 Return SubList slice (const access) - with range checking.
scalar & operator[] (const label i)
 Return element of UList.
const scalar & operator[] (const label i) const
 Return element of constant UList.
 operator const Foam::List< scalar > & () const
 Allow cast to a const List<T>&.
void operator= (const scalar &val)
 Assignment of all entries to the given value.
void operator= (Foam::zero)
 Assignment of all entries to zero.
iterator begin () noexcept
 Return an iterator to begin traversing the UList.
iterator end () noexcept
 Return an iterator to end traversing the UList.
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList.
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList.
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList.
bool empty () const noexcept
 True if List is empty (ie, size() is zero).
label size () const noexcept
 The number of elements in the container.
label capacity () const noexcept
 Size of the underlying storage.
void swap (UList< scalar > &list) noexcept
 Swap content with another UList of the same type in constant time.
bool operator== (const UList< scalar > &list) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< scalar > &list) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< scalar > &list) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< scalar > &list) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< scalar > &list) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< scalar > &list) const
 Return true if !(a < b). Takes linear time.
IstreamreadList (Istream &is)
 Read List contents from Istream.
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword.
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen.
bool all () const
 True if all entries are 'true' or if the list is empty.
bool any () const
 True if any entries are 'true'.
bool none () const
 True if no entries are 'true'.
bool test (const label i) const
 Test bool value at specified position, always false for out-of-range access.
bool get (const label i) const
 Return bool value at specified position, always false for out-of-range access.
bool unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access.
std::string_view view () const
 Return a string_view of the charList. Content is non-modifiable.
scalar & first ()
 Access first element of the list, position [0].
const scalar & first () const
 Access first element of the list.
scalar & last ()
 Access last element of the list, position [size()-1].
const scalar & last () const
 Access last element of the list, position [size()-1].
bool found (const scalar &val, label pos=0) const
 Same as contains().
auto expr () const
 Wrap value as expression.
void operator= (const Expression::ListExpression< E > &expr)
 Assign values from expression.
 operator const Foam::List< scalar > & () const
 Allow cast to a const List<T>&.

Additional Inherited Members

Public Types inherited from fvPatchField< scalar >
typedef fvPatch Patch
 The patch type for the patch field.
typedef scalar value_type
 The value_type for the patch field.
typedef pTraits< scalar >::cmptType cmptType
 The component type for patch field.
typedef DimensionedField< scalar, volMeshInternal
 The internal field type associated with the patch field.
typedef calculatedFvPatchField< scalar > Calculated
 Type for a calculated patch.
Public Types inherited from Field< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type.
typedef SubField< scalar > subField
 Declare type of subField.
Public Types inherited from List< scalar >
typedef SubList< scalar > subList
 Declare type of subList.
Public Types inherited from UList< scalar >
typedef scalar value_type
 The value type the list contains.
typedef scalar * pointer
 The pointer type for non-const access to value_type items.
typedef const scalar * const_pointer
 The pointer type for const access to value_type items.
typedef scalar & reference
 The type used for storing into value_type objects.
typedef const scalar & const_reference
 The type used for reading from constant value_type objects.
typedef scalar * iterator
 Random access iterator for traversing a UList.
typedef const scalar * const_iterator
 Random access iterator for traversing a UList.
typedef label size_type
 The type to represent the size of a UList.
typedef label difference_type
 The difference between iterator objects.
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access).
using is_List
 Have unique tag.
Static Public Member Functions inherited from fvPatchField< scalar >
static tmp< fvPatchField< scalar > > Clone (const DerivedPatchField &pf, Args &&... args)
 Clone a patch field, optionally with internal field reference etc.
static tmp< fvPatchField< scalar > > New (const word &patchFieldType, const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Return a pointer to a new patchField created on freestore given.
static tmp< fvPatchField< scalar > > New (const word &patchFieldType, const word &actualPatchType, const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Return a pointer to a new patchField created on freestore given.
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.
static tmp< fvPatchField< scalar > > New (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore.
static tmp< fvPatchField< scalar > > NewCalculatedType (const fvPatch &p)
 Return a pointer to a new calculatedFvPatchField created on.
static tmp< fvPatchField< scalar > > NewCalculatedType (const fvPatchField< AnyType > &pf)
 Return a pointer to a new calculatedFvPatchField created on.
Static Public Member Functions inherited from fvPatchFieldBase
static const wordemptyType () noexcept
 The type name for empty patch fields.
static const wordcalculatedType () noexcept
 The type name for calculated patch fields.
static const wordextrapolatedCalculatedType () noexcept
 The type name for extrapolatedCalculated patch fields combines zero-gradient and calculated.
static const wordzeroGradientType () noexcept
 The type name for zeroGradient patch fields.
static const wordzeroValueType () noexcept
 The type name for zeroValue patch fields.
Static Public Member Functions inherited from Field< scalar >
static const Field< scalar > & null () noexcept
 Return a null Field (reference to a nullObject). Behaves like an empty Field.
static autoPtr< Field< scalar > > New (Istream &is)
 Return a pointer to a new Field created on freestore.
static tmp< Field< scalar > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values.
Static Public Member Functions inherited from FieldBase
static void warnLocalBoundaryConsistencyCompat (const dictionary &)
 Warn about keyword changes for local boundary consistency checks.
static int localBoundaryConsistency () noexcept
 Get flag for local boundary consistency checks.
static int localBoundaryConsistency (int val) noexcept
 Set flag for local boundary consistency checks.
Static Public Member Functions inherited from List< scalar >
static const List< scalar > & null () noexcept
 Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< scalar >
static const UList< scalar > & null () noexcept
 Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label max_size () noexcept
 The size of the largest possible UList.
Static Public Attributes inherited from fvPatchFieldBase
static int disallowGenericPatchField
 Debug switch to disallow the use of generic fvPatchField.
Static Public Attributes inherited from FieldBase
static const char *const typeName
 Typename for Field.
static bool allowConstructFromLargerSize = false
 Permit read construct from a larger size.
static bool unifiedGeometricField
 GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int localBoundaryConsistency_
 Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar localBoundaryTolerance_
 Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".
Protected Member Functions inherited from fvPatchField< scalar >
bool readValueEntry (const dictionary &dict, IOobjectOption::readOption readOpt=IOobjectOption::LAZY_READ)
 Read the "value" entry into *this.
void writeValueEntry (Ostream &os) const
 Write *this field as a "value" entry.
void extrapolateInternal ()
 Assign the patch field from the internal field.
Protected Member Functions inherited from fvPatchFieldBase
virtual void readDict (const dictionary &dict)
 Read dictionary entries.
Protected Member Functions inherited from UList< scalar >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage.
void size (const label n)
 Older name for setAddressableSize.
void writeEntry (Ostream &os) const
 Write the UList with its compound type.
labelRange validateRange (const labelRange &requestedRange) const
 Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void fill_uniform (const scalar &val)
 Assign all entries to the given value.
void fill_uniform (Foam::zero)
 Assign all entries to zero.

Detailed Description

This boundary condition provides a jump condition, using the cyclic condition as a base.

The porous baffle introduces a pressure jump defined by:

\‍[    \Delta p = -(D \mu U + 0.5 I \rho |U|^2 )L
\‍]

where

$        p      $=pressure [Pa]
$        \rho   $=density [kg/m3]
$        \mu    $=laminar viscosity [Pa s]
$        D      $=Darcy coefficient
$        I      $=inertial coefficient
$        L      $=porous media length in the flow direction
Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries
    type            porousBafflePressure;
    D               0.001;
    I               1000000;
    length          0.1;

    // Optional entries
    phi             phi;
    rho             rho;
    uniformJump     false;
    value           uniform 0;

    // Inherited entries
    patchType       cyclic;
    jump            uniform 0;
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: porousBafflePressure word yes -
D Darcy coefficient Function1<scalar> yes -
I Inertial coefficient Function1<scalar> yes -
length Porous media length in the flow direction scalar yes -
uniformJump Flag to apply a uniform pressure drop on the patch based on the bool no false
phi Name of flux field word no phi
rho Name of density field word no rho
patchType Underlying patch type should be cyclic word yes -
jump Jump value scalarField yes -

The inherited entries are elaborated in:

Note
The underlying patchType should be set to cyclic.
Source files

Definition at line 203 of file porousBafflePressureFvPatchField.H.

Constructor & Destructor Documentation

◆ porousBafflePressureFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 29 of file porousBafflePressureFvPatchField.C.

References fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), and p.

Referenced by porousBafflePressureFvPatchField(), porousBafflePressureFvPatchField(), porousBafflePressureFvPatchField(), and TypeName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ porousBafflePressureFvPatchField() [2/5]

porousBafflePressureFvPatchField ( const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF,
const dictionary & dict,
const bool needValue = true )

◆ porousBafflePressureFvPatchField() [3/5]

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

Construct by mapping given porousBafflePressureFvPatchField onto a new patch.

Definition at line 71 of file porousBafflePressureFvPatchField.C.

References clone(), fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), p, and porousBafflePressureFvPatchField().

Here is the call graph for this function:

◆ porousBafflePressureFvPatchField() [4/5]

porousBafflePressureFvPatchField ( const porousBafflePressureFvPatchField & ptf)

Construct as copy.

Definition at line 89 of file porousBafflePressureFvPatchField.C.

References clone(), fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), and porousBafflePressureFvPatchField().

Here is the call graph for this function:

◆ porousBafflePressureFvPatchField() [5/5]

porousBafflePressureFvPatchField ( const porousBafflePressureFvPatchField & ptf,
const DimensionedField< scalar, volMesh > & iF )

Construct as copy setting internal field reference.

Definition at line 105 of file porousBafflePressureFvPatchField.C.

References clone(), fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), and porousBafflePressureFvPatchField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "porousBafflePressure" )

Runtime type information.

References porousBafflePressureFvPatchField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Reimplemented from fixedJumpFvPatchField< scalar >.

Definition at line 302 of file porousBafflePressureFvPatchField.H.

References fvPatchField< Type >::Clone().

Referenced by porousBafflePressureFvPatchField(), porousBafflePressureFvPatchField(), and porousBafflePressureFvPatchField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Reimplemented from fvPatchField< scalar >.

Definition at line 310 of file porousBafflePressureFvPatchField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

◆ write()

void write ( Ostream & os) const
virtual

Write.

Reimplemented from fixedJumpFvPatchField< scalar >.

Definition at line 193 of file porousBafflePressureFvPatchField.C.

References os(), and fixedJumpFvPatchField< Type >::write().

Here is the call graph for this function:

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