FreeFOAM The Cross-Platform CFD Toolkit
advectiveFvPatchField< Type > Class Template Reference

Advective outflow boundary condition based on solving DDt(psi, U) = 0 at the boundary. More...

#include <finiteVolume/advectiveFvPatchField.H>


Detailed Description

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

Advective outflow boundary condition based on solving DDt(psi, U) = 0 at the boundary.

The standard (Euler, backward, CrankNicholson) 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 at the outlet is provided by the virtual function advectionSpeed() the default implementation of which requires the name of flux field a the outlet (phi) and optionally the density (rho) if the mass-flux rather than the volumetric-flux is given.

outlet
{
typeadvective;
phi phi;
// rho  rho; // Not needed, phi volumetric
// fieldInf 1e5; // Optional
// lInf 0.1; // Optional
}

The flow/wave speed at the outlet can be changed by deriving a specialised BC fron this class and overriding 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.

Source files

Definition at line 78 of file advectiveFvPatchField.H.

+ Inheritance diagram for advectiveFvPatchField< Type >:
+ Collaboration diagram for advectiveFvPatchField< Type >:

List of all members.

Public Member Functions

 TypeName ("advective")
 Runtime type information.
 advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field.
 advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 advectiveFvPatchField (const advectiveFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given advectiveFvPatchField.
 advectiveFvPatchField (const advectiveFvPatchField &)
 Construct as copy.
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone.
 advectiveFvPatchField (const advectiveFvPatchField &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference.
const Type & fieldInf () const
 Return the field at infinity.
Type & fieldInf ()
 Return reference to the field at infinity to allow adjustment.
scalar lInf () const
 Return the relaxation length-scale.
scalar & lInf ()
 Return reference to the relaxation length-scale.
virtual tmp< scalarFieldadvectionSpeed () const
 Calculate and return the advection speed at the boundary.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.
- Public Member Functions inherited from mixedFvPatchField< Type >
 TypeName ("mixed")
 Runtime type information.
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field.
 mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given mixedFvPatchField onto a new patch.
 mixedFvPatchField (const mixedFvPatchField< Type > &)
 Construct as copy.
 mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference.
virtual bool fixesValue () const
 Return true if this patch field fixes a value.
virtual Field< Type > & refValue ()
virtual const Field< Type > & refValue () const
virtual Field< Type > & refGrad ()
virtual const Field< Type > & refGrad () const
virtual scalarFieldvalueFraction ()
virtual const scalarFieldvalueFraction () const
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual tmp< Field< Type > > snGrad () const
 Return gradient at boundary.
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field.
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the.
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the.
virtual void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time.
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 &)
 Assignment of all entries to the given value.
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")
 Runtime type information.
 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 > &)
 Construct from patch and internal field.
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field.
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
 Construct from patch, internal field and dictionary.
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch.
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy.
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference.
virtual ~fvPatchField ()
const objectRegistrydb () const
 Return local objectRegistry.
const fvPatchpatch () const
 Return patch.
const DimensionedField< Type,
volMesh > & 
dimensionedInternalField () const
 Return dimensioned internal field reference.
const Field< Type > & internalField () const
 Return internal field reference.
virtual bool coupled () const
 Return true if this patch field is coupled.
bool updated () const
 Return true if the boundary condition has already been updated.
virtual tmp< Field< Type > > patchInternalField () const
 Return internal field next to patch as patch field.
virtual tmp< Field< Type > > patchNeighbourField () const
 Return patchField on the opposite patch of a coupled patch.
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise the evaluation of the patch field.
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix.
template<class EntryType >
void writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
 Helper function to write the keyword and entry only if the.
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type>
virtual void operator== (const fvPatchField< Type > &)
virtual void operator== (const Field< Type > &)
virtual void operator== (const Type &)
- Public Member Functions inherited from Field< Type >
 Field ()
 Construct null.
 Field (const label)
 Construct given size.
 Field (const label, const Type &)
 Construct given size and initial value.
 Field (const UList< Type > &)
 Construct as copy of a UList<Type>
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents.
 Field (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 Construct by 1 to 1 mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field.
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field.
 Field (const UList< Type > &mapF, const FieldMapper &map)
 Construct by mapping from the given field.
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Construct by mapping from the given tmp field.
 Field (const Field< Type > &)
 Construct as copy.
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified.
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents.
 Field (const typename Field< Type >::subField &)
 Construct as copy of subField.
 Field (Istream &)
 Construct as copy of tmp<Field>
 Field (const word &keyword, const dictionary &dict, const label size)
 Construct from a dictionary entry.
void map (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 1 to 1 map from the given field
void map (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 1 to 1 map from the given tmp field
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field.
void map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field.
void map (const UList< Type > &mapF, const FieldMapper &map)
 Map from the given field.
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Map from the given tmp field.
void autoMap (const FieldMapper &map)
 Map from self.
void rmap (const UList< Type > &mapF, const unallocLabelList &mapAddressing)
 1 to 1 reverse-map from the given field
void rmap (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing)
 1 to 1 reverse-map from the given tmp field
void rmap (const UList< Type > &mapF, const unallocLabelList &mapAddressing, const scalarList &weights)
 Interpolative reverse map from the given field.
void rmap (const tmp< Field< Type > > &tmapF, const unallocLabelList &mapAddressing, const scalarList &weights)
 Interpolative reverse map from the given tmp field.
void negate ()
 Negate this field.
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.
tmp< Field< Type > > 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.
void operator= (const Field< Type > &)
void operator= (const SubField< Type > &)
void operator= (const tmp< Field< Type > > &)
template<class Form , class Cmpt , int nCmpt>
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void operator+= (const UList< Type > &)
void operator+= (const tmp< Field< Type > > &)
void operator-= (const UList< Type > &)
void operator-= (const tmp< Field< Type > > &)
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 &)
template<class Type>
void operator= (const tmp< Field > &rhs)
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.
- Public Member Functions inherited from List< Type >
label size () const
 Return the number of elements in the UList.
 List ()
 Null constructor.
 List (const label)
 Construct with given size.
 List (const label, const Type &)
 Construct with given size and value for all elements.
 List (const List< Type > &)
 Copy constructor.
 List (const Xfer< List< Type > > &)
 Construct by transferring the parameter contents.
 List (List< Type > &, bool reUse)
 Construct as copy or re-use as specified.
 List (const UList< Type > &, const unallocLabelList &mapAddressing)
 Construct as subset.
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators.
 List (const FixedList< Type, Size > &)
 Construct as copy of FixedList<T, Size>
 List (const PtrList< Type > &)
 Construct as copy of PtrList<T>
 List (const SLList< Type > &)
 Construct as copy of SLList<T>
 List (const IndirectList< Type > &)
 Construct as copy of IndirectList<T>
 List (const UIndirectList< Type > &)
 Construct as copy of UIndirectList<T>
 List (const BiIndirectList< Type > &)
 Construct as copy of BiIndirectList<T>
 List (Istream &)
 Construct from Istream.
 ~List ()
void resize (const label)
 Reset size of List.
void resize (const label, const Type &)
 Reset size of List and value for new elements.
void setSize (const label)
 Reset size of List.
void setSize (const label, const Type &)
 Reset size of List and value for new elements.
void clear ()
 Clear the list, i.e. set size to zero.
void append (const UList< Type > &)
 Append a List at the end of this list.
void append (const UIndirectList< Type > &)
 Append a UIndirectList at the end of this list.
void transfer (List< Type > &)
 Transfer the contents of the argument List into this list.
void transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list.
void transfer (SortableList< Type > &)
 Transfer the contents of the argument List into this list.
Xfer< List< Type > > xfer ()
 Transfer contents to the Xfer container.
Type & newElmt (const label)
 Return subscript-checked element of UList.
void operator= (const List< Type > &)
 Assignment operator. Takes linear time.
void operator= (const SLList< Type > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const IndirectList< Type > &)
 Assignment from IndirectList operator. Takes linear time.
void operator= (const UIndirectList< Type > &)
 Assignment from UIndirectList operator. Takes linear time.
void operator= (const BiIndirectList< Type > &)
 Assignment from BiIndirectList operator. Takes linear time.
- Public Member Functions inherited from UList< Type >
 UList ()
 Null constructor.
 UList (Type *__restrict__ v, label size)
 Construct from components.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
label byteSize () const
 Return the binary size in number of characters of the UList.
const Type * cdata () const
 Return a const pointer to the first data element,.
Type * data ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void writeEntry (Ostream &) const
 Write the UList as a dictionary entry.
void assign (const UList< Type > &)
 Assign elements to those from UList.
Type & operator[] (const label)
 Return element of UList.
const Type & operator[] (const label) const
 Return element of constant UList.
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&.
iterator begin ()
 Return an iterator to begin traversing the UList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList.
iterator end ()
 Return an iterator to end traversing the UList.
const_iterator end () const
 Return const_iterator to end traversing the constant UList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList.
const_iterator cend () const
 Return const_iterator to end traversing the constant UList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator rend () const
 Return const_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.
label max_size () const
 Return size of the largest possible UList.
bool empty () const
 Return true if the UList is empty (ie, size() is zero).
void swap (UList< Type > &)
 Swap two ULists of the same type in constant time.
bool operator== (const UList< Type > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UList< Type > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator> (const UList< Type > &) const
 Compare two ULists lexicographically. Takes linear time.
bool operator<= (const UList< Type > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const UList< Type > &) const
 Return true if !(a < b). Takes linear time.

Protected Attributes

word phiName_
 Name of the flux transporting the field.
word rhoName_
 Name of the density field used to normalise the mass flux.
Type fieldInf_
 Field value of the far-field.
scalar lInf_
 Relaxation length-scale.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 43 of file advectiveFvPatchField.C.

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

Construct by mapping given advectiveFvPatchField.

onto a new patch

advectiveFvPatchField ( const advectiveFvPatchField< Type > &  ptpsf)

Construct as copy.

Definition at line 131 of file advectiveFvPatchField.C.

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

Construct as copy setting internal field reference.

Definition at line 145 of file advectiveFvPatchField.C.


Member Function Documentation

TypeName ( "advective"  )

Runtime type information.

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

Construct and return a clone.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 140 of file advectiveFvPatchField.H.

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

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 157 of file advectiveFvPatchField.H.

const Type& fieldInf ( ) const
inline

Return the field at infinity.

Definition at line 173 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

Type& fieldInf ( )
inline

Return reference to the field at infinity to allow adjustment.

Definition at line 179 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

scalar lInf ( ) const
inline

Return the relaxation length-scale.

Definition at line 185 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::lInf_.

scalar& lInf ( )
inline

Return reference to the relaxation length-scale.

to allow adjustment

Definition at line 192 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::lInf_.

tmp< scalarField > advectionSpeed ( ) const
virtual

Calculate and return the advection speed at the boundary.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 161 of file advectiveFvPatchField.C.

References Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, and phi.

void write ( Ostream os) const
virtual

Member Data Documentation

word phiName_
protected

Name of the flux transporting the field.

Definition at line 87 of file advectiveFvPatchField.H.

word rhoName_
protected

Name of the density field used to normalise the mass flux.

if neccessary

Definition at line 91 of file advectiveFvPatchField.H.

Type fieldInf_
protected

Field value of the far-field.

Definition at line 94 of file advectiveFvPatchField.H.

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

scalar lInf_
protected

Relaxation length-scale.

Definition at line 97 of file advectiveFvPatchField.H.

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


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