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

Abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used. More...

#include <finiteVolume/fvPatchField.H>


Detailed Description

template<class Type>
class Foam::fvPatchField< Type >

Abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used.

The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions.

The next level of derivation covers all the specialised types with specific evaluation proceedures, particularly with respect to specific fields.

Source files

Definition at line 80 of file fvPatchField.H.

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

List of all members.

Public Types

typedef fvPatch Patch
- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type.
typedef SubField< Type > subField
 Declare type of subField.
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList.
- Public Types inherited from UList< Type >
typedef Type value_type
 Type of values the UList contains.
typedef Type & reference
 Type that can be used for storing into.
typedef const Type & const_reference
 Type that can be used for storing into.
typedef label difference_type
 The type that can represent the difference between any two.
typedef label size_type
 The type that can represent the size of a UList.
typedef Type * iterator
 Random access iterator for traversing UList.
typedef const Type * const_iterator
 Random access iterator for traversing UList.
typedef Type * reverse_iterator
 Reverse iterator for reverse traversal of UList.
typedef const Type * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList.

Public Member Functions

 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.
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone.
 fvPatchField (const fvPatchField< Type > &, 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.
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 fixesValue () const
 Return true if this patch field fixes a value.
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 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 patch-normal gradient.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
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 evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field, sets Updated to false.
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar > > &) const
 Return the matrix diagonal coefficients corresponding to the.
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar > > &) 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 manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix.
virtual void write (Ostream &) const
 Write.
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 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)
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.

Static Public Member Functions

static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given.
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from.
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore.
template<class Type2 >
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on.
static const wordcalculatedType ()
 Return the type of the calculated for of fvPatchField.
- Static Public Member Functions inherited from Field< Type >
static const Field< Type > & null ()
 Return a null field.
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on.

Static Public Attributes

static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField.
- Static Public Attributes inherited from Field< Type >
static const char *const typeName

Friends

Ostreamoperator (Ostream &, const fvPatchField< Type > &)

Member Typedef Documentation

typedef fvPatch Patch

Definition at line 104 of file fvPatchField.H.


Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 36 of file fvPatchField.C.

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

Construct from patch and internal field and patch field.

Definition at line 51 of file fvPatchField.C.

fvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary dict,
const bool  valueRequired = false 
)

Construct from patch, internal field and dictionary.

Definition at line 84 of file fvPatchField.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), and fvPatch::size().

fvPatchField ( const fvPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping the given fvPatchField onto a new patch.

Definition at line 67 of file fvPatchField.C.

fvPatchField ( const fvPatchField< Type > &  ptf)

Construct as copy.

Definition at line 128 of file fvPatchField.C.

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

Construct as copy setting internal field reference.

Definition at line 142 of file fvPatchField.C.

virtual ~fvPatchField ( )
inlinevirtual

Definition at line 259 of file fvPatchField.H.


Member Function Documentation

TypeName ( "fvPatchField< Type >"  )

Runtime type information.

declareRunTimeSelectionTable ( tmp  ,
fvPatchField< Type >  ,
patch  ,
(const fvPatch &p, const DimensionedField< Type, volMesh > &iF)  ,
(p, iF)   
)
declareRunTimeSelectionTable ( tmp  ,
fvPatchField< Type >  ,
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< Type >  ,
dictionary  ,
(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict)  ,
(p, iF, dict)   
)
virtual tmp<fvPatchField<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from Field< Type >.

Reimplemented in timeVaryingMappedFixedValueFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, omegaWallFunctionFvPatchScalarField, advectiveFvPatchField< Type >, epsilonWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, timeVaryingUniformFixedValueFvPatchField< Type >, timeVaryingUniformInletOutletFvPatchField< Type >, oscillatingFixedValueFvPatchField< Type >, turbulentInletFvPatchField< Type >, cyclicFvPatchField< Type >, directMappedFixedValueFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, processorFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, genericFvPatchField< Type >, mixedFvPatchField< Type >, slicedFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, coupledFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, fanFvPatchField< Type >, inletOutletFvPatchField< Type >, directionMixedFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, fixedGradientFvPatchField< Type >, partialSlipFvPatchField< Type >, fixedInternalValueFvPatchField< Type >, fixedInternalValueFvPatchField< scalar >, cellMotionFvPatchField< Type >, basicSymmetryFvPatchField< Type >, calculatedFvPatchField< Type >, fixedValueFvPatchField< Type >, zeroGradientFvPatchField< Type >, emptyFvPatchField< Type >, symmetryFvPatchField< Type >, wedgeFvPatchField< Type >, zeroGradientFvPatchField< scalar >, transformFvPatchField< Type >, freestreamFvPatchField< Type >, outletInletFvPatchField< Type >, and slipFvPatchField< Type >.

Definition at line 195 of file fvPatchField.H.

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

Construct and return a clone setting internal field reference.

Reimplemented in timeVaryingMappedFixedValueFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, omegaWallFunctionFvPatchScalarField, advectiveFvPatchField< Type >, epsilonWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, timeVaryingUniformFixedValueFvPatchField< Type >, timeVaryingUniformInletOutletFvPatchField< Type >, oscillatingFixedValueFvPatchField< Type >, turbulentInletFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, cyclicFvPatchField< Type >, directMappedFixedValueFvPatchField< Type >, processorFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, genericFvPatchField< Type >, mixedFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, fanFvPatchField< Type >, inletOutletFvPatchField< Type >, directionMixedFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, fixedGradientFvPatchField< Type >, slicedFvPatchField< Type >, partialSlipFvPatchField< Type >, coupledFvPatchField< Type >, fixedInternalValueFvPatchField< Type >, fixedInternalValueFvPatchField< scalar >, cellMotionFvPatchField< Type >, basicSymmetryFvPatchField< Type >, calculatedFvPatchField< Type >, fixedValueFvPatchField< Type >, zeroGradientFvPatchField< Type >, emptyFvPatchField< Type >, symmetryFvPatchField< Type >, wedgeFvPatchField< Type >, zeroGradientFvPatchField< scalar >, freestreamFvPatchField< Type >, outletInletFvPatchField< Type >, slipFvPatchField< Type >, and transformFvPatchField< Type >.

Definition at line 209 of file fvPatchField.H.

Foam::tmp< Foam::fvPatchField< Type > > New ( const word patchFieldType,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)
static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

Definition at line 30 of file newFvPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.

Foam::tmp< Foam::fvPatchField< Type > > New ( const fvPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper pfMapper 
)
static

Return a pointer to a new patchField created on freestore from.

a given fvPatchField mapped onto a new patch

Definition at line 152 of file newFvPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.

Foam::tmp< Foam::fvPatchField< Type > > New ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary dict 
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 76 of file newFvPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), and p.

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

Return a pointer to a new calculatedFvPatchField created on.

freestore without setting patchField values

Definition at line 103 of file calculatedFvPatchField.C.

References DimensionedField< Type, GeoMesh >::null(), and fvPatchField< Type >::patch().

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 158 of file fvPatchField.C.

const DimensionedField<Type, volMesh>& dimensionedInternalField ( ) const
inline

Return dimensioned internal field reference.

Definition at line 278 of file fvPatchField.H.

const Field<Type>& internalField ( ) const
inline

Return internal field reference.

Definition at line 284 of file fvPatchField.H.

const word & calculatedType ( )
static

Return the type of the calculated for of fvPatchField.

Definition at line 35 of file calculatedFvPatchField.C.

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented in mixedFvPatchField< Type >, directionMixedFvPatchField< Type >, slicedFvPatchField< Type >, calculatedFvPatchField< Type >, and fixedValueFvPatchField< Type >.

Definition at line 295 of file fvPatchField.H.

Referenced by Foam::adjustPhi(), faceLimitedGrad< Type >::grad(), faceMDLimitedGrad< Type >::grad(), and Foam::fv::makeFvGradScheme().

bool updated ( ) const
inline

Return true if the boundary condition has already been updated.

Definition at line 307 of file fvPatchField.H.

virtual void initEvaluate ( const Pstream::commsTypes  commsType = Pstream::blocking)
inlinevirtual

Initialise the evaluation of the patch field.

Reimplemented in slicedFvPatchField< Type >, processorFvPatchField< Type >, and coupledFvPatchField< Type >.

Definition at line 353 of file fvPatchField.H.

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

Evaluate the patch field, sets Updated to false.

Reimplemented in mixedFvPatchField< Type >, directionMixedFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, slicedFvPatchField< Type >, fixedGradientFvPatchField< Type >, epsilonWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, fixedNormalSlipFvPatchField< Type >, processorFvPatchField< Type >, partialSlipFvPatchField< Type >, coupledFvPatchField< Type >, basicSymmetryFvPatchField< Type >, wedgeFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, zeroGradientFvPatchField< Type >, zeroGradientFvPatchField< scalar >, basicSymmetryFvPatchField< Type >, wedgeFvPatchField< Type >, basicSymmetryFvPatchField< Type >, and wedgeFvPatchField< Type >.

Definition at line 215 of file fvPatchField.C.

Referenced by basicSymmetryFvPatchField< Type >::evaluate(), zeroGradientFvPatchField< Type >::evaluate(), coupledFvPatchField< Type >::evaluate(), partialSlipFvPatchField< Type >::evaluate(), fixedNormalSlipFvPatchField< Type >::evaluate(), fixedGradientFvPatchField< Type >::evaluate(), mixedFixedValueSlipFvPatchField< Type >::evaluate(), directionMixedFvPatchField< Type >::evaluate(), mixedFvPatchField< Type >::evaluate(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedInternalEnergyFvPatchScalarField::updateCoeffs(), fixedEnthalpyFvPatchScalarField::updateCoeffs(), gradientEnthalpyFvPatchScalarField::updateCoeffs(), and gradientInternalEnergyFvPatchScalarField::updateCoeffs().

virtual tmp<Field<Type> > valueInternalCoeffs ( const tmp< Field< scalar > > &  ) const
inlinevirtual
virtual tmp<Field<Type> > valueBoundaryCoeffs ( const tmp< Field< scalar > > &  ) const
inlinevirtual
virtual tmp<Field<Type> > gradientBoundaryCoeffs ( ) const
inlinevirtual
void manipulateMatrix ( fvMatrix< Type > &  matrix)
virtual

Manipulate matrix.

Reimplemented in fixedInternalValueFvPatchField< Type >, and fixedInternalValueFvPatchField< scalar >.

Definition at line 227 of file fvPatchField.C.

void write ( Ostream os) const
virtual

Write.

Reimplemented in timeVaryingMappedFixedValueFvPatchField< Type >, mixedFvPatchField< Type >, advectiveFvPatchField< Type >, directionMixedFvPatchField< Type >, oscillatingFixedValueFvPatchField< Type >, slicedFvPatchField< Type >, fixedGradientFvPatchField< Type >, turbulentInletFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, coupledFvPatchField< Type >, omegaWallFunctionFvPatchScalarField, mixedFixedValueSlipFvPatchField< Type >, genericFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, epsilonWallFunctionFvPatchScalarField, epsilonWallFunctionFvPatchScalarField, partialSlipFvPatchField< Type >, fanFvPatchField< Type >, timeVaryingUniformFixedValueFvPatchField< Type >, timeVaryingUniformInletOutletFvPatchField< Type >, calculatedFvPatchField< Type >, fixedValueFvPatchField< Type >, waveTransmissiveFvPatchField< Type >, uniformFixedValueFvPatchField< Type >, outletMappedUniformInletFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, kqRWallFunctionFvPatchField< Type >, directMappedFixedValueFvPatchField< Type >, surfaceSlipDisplacementFvPatchField< Type >, freestreamFvPatchField< Type >, inletOutletFvPatchField< Type >, cellMotionFvPatchField< Type >, and outletInletFvPatchField< Type >.

Definition at line 234 of file fvPatchField.C.

References Foam::nl, Foam::type(), and Ostream::writeKeyword().

Referenced by Foam::operator<<(), outletInletFvPatchField< Type >::write(), cellMotionFvPatchField< Type >::write(), inletOutletFvPatchField< Type >::write(), freestreamFvPatchField< Type >::write(), directMappedFixedValueFvPatchField< Type >::write(), fixedPressureCompressibleDensityFvPatchScalarField::write(), outletMappedUniformInletFvPatchField< Type >::write(), uniformFixedValueFvPatchField< Type >::write(), waveTransmissiveFvPatchField< Type >::write(), cylindricalInletVelocityFvPatchVectorField::write(), fixedValueFvPatchField< Type >::write(), calculatedFvPatchField< Type >::write(), fanFvPatchField< Type >::write(), swirlFlowRateInletVelocityFvPatchVectorField::write(), partialSlipFvPatchField< Type >::write(), flowRateInletVelocityFvPatchVectorField::write(), fixedNormalSlipFvPatchField< Type >::write(), activeBaffleVelocityFvPatchVectorField::write(), mixedFixedValueSlipFvPatchField< Type >::write(), coupledFvPatchField< Type >::write(), turbulentInletFvPatchField< Type >::write(), fixedGradientFvPatchField< Type >::write(), slicedFvPatchField< Type >::write(), incompressible::atmBoundaryLayerInletVelocityFvPatchVectorField::write(), directionMixedFvPatchField< Type >::write(), advectiveFvPatchField< Type >::write(), mixedFvPatchField< Type >::write(), and timeVaryingMappedFixedValueFvPatchField< Type >::write().

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.

values are not equal. The value is then output as value2

Definition at line 249 of file fvPatchField.C.

References Foam::nl, and Ostream::writeKeyword().

void check ( const fvPatchField< Type > &  ptf) const

Check fvPatchField<Type> against given fvPatchField<Type>

Definition at line 165 of file fvPatchField.C.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

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

Assignment from UList operator. Takes linear time.

Reimplemented from Field< Type >.

Reimplemented in mixedFvPatchField< Type >, slicedFvPatchField< Type >, mixedFixedValueSlipFvPatchField< Type >, fixedNormalSlipFvPatchField< Type >, partialSlipFvPatchField< Type >, and fixedValueFvPatchField< Type >.

Definition at line 267 of file fvPatchField.C.

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), buoyantPressureFvPatchScalarField::buoyantPressureFvPatchScalarField(), cellMotionFvPatchField< Type >::cellMotionFvPatchField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), inletOutletFvPatchField< Type >::inletOutletFvPatchField(), movingWallVelocityFvPatchVectorField::movingWallVelocityFvPatchVectorField(), pressureInletVelocityFvPatchVectorField::operator=(), pressureInletOutletVelocityFvPatchVectorField::operator=(), pressureDirectedInletVelocityFvPatchVectorField::operator=(), outletInletFvPatchField< Type >::outletInletFvPatchField(), pressureDirectedInletOutletVelocityFvPatchVectorField::pressureDirectedInletOutletVelocityFvPatchVectorField(), pressureDirectedInletVelocityFvPatchVectorField::pressureDirectedInletVelocityFvPatchVectorField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureInletVelocityFvPatchVectorField::pressureInletVelocityFvPatchVectorField(), pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField(), smoluchowskiJumpTFvPatchScalarField::smoluchowskiJumpTFvPatchScalarField(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField(), syringePressureFvPatchScalarField::syringePressureFvPatchScalarField(), and zeroGradientFvPatchField< Type >::zeroGradientFvPatchField().

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

Definition at line 449 of file fvPatchField.C.

References tf.

void operator== ( const Type &  t)
virtual

Definition at line 459 of file fvPatchField.C.


Friends And Related Function Documentation

Ostream& operator ( Ostream ,
const fvPatchField< Type > &   
)
friend

Member Data Documentation

int disallowGenericFvPatchField
static

Debug switch to disallow the use of genericFvPatchField.

Definition at line 111 of file fvPatchField.H.


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