Public Member Functions | List of all members
directionMixedFvPatchField< Type > Class Template Reference

Base class for direction-mixed boundary conditions. More...

Inheritance diagram for directionMixedFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for directionMixedFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("directionMixed")
 Runtime type information. More...
 
 directionMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 directionMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 directionMixedFvPatchField (const directionMixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given directionMixedFvPatchField onto. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 directionMixedFvPatchField (const directionMixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual bool fixesValue () const
 True: this patch field fixes a value. More...
 
virtual bool assignable () const
 False: this patch field is not altered by assignment. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual Field< Type > & refValue ()
 
virtual const Field< Type > & refValue () const
 
virtual Field< Type > & refGrad ()
 
virtual const Field< Type > & refGrad () const
 
virtual symmTensorFieldvalueFraction ()
 
virtual const symmTensorFieldvalueFraction () const
 
virtual tmp< Field< Type > > snGrad () const
 Return gradient at boundary. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Evaluate the patch field. More...
 
virtual tmp< Field< Type > > snGradTransformDiag () const
 Return face-gradient transform diagonal. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator*= (const fvPatchField< Type > &)
 
virtual void operator/= (const fvPatchField< Type > &)
 
virtual void operator= (const Field< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const scalar)
 
- Public Member Functions inherited from transformFvPatchField< Type >
 TypeName ("transform")
 Runtime type information. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given transform patch field onto a new patch. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &)
 Construct as copy. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
template<>
tmp< scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 
template<>
tmp< scalarFieldgradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
template<>
Foam::tmp< Foam::scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 
template<>
Foam::tmp< Foam::scalarFieldgradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
- Public Member Functions inherited from fvPatchField< Type >
 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. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 Construct from patch, internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 Construct from patch, internal field and value. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &pfld)
 Construct from patch, internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, Field< Type > &&pfld)
 Construct from patch, internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &dict, IOobjectOption::readOption requireValue=IOobjectOption::MUST_READ)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict, const bool valueReqd)
 Construct, forwarding to readOption variant. More...
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~fvPatchField ()=default
 Destructor. More...
 
const DimensionedField< Type, volMesh > & internalField () const noexcept
 Return const-reference to the dimensioned internal field. More...
 
const Field< Type > & primitiveField () const noexcept
 Return const-reference to the internal field values. More...
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient for coupled-patches. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< Type > > patchInternalField () const
 Return internal field next to patch. More...
 
virtual void patchInternalField (Field< Type > &pfld) const
 Extract internal field next to patch. More...
 
virtual tmp< Field< Type > > patchNeighbourField () const
 Return patchField on the opposite patch of a coupled patch. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Initialise the evaluation of the patch field. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix. More...
 
void check (const fvPatchField< Type > &) const
 Check against given patch field. More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
- Public Member Functions inherited from fvPatchFieldBase
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 fvPatchFieldBase (const fvPatch &p)
 Construct from patch. More...
 
 fvPatchFieldBase (const fvPatch &p, const word &patchType)
 Construct from patch and patch type. More...
 
 fvPatchFieldBase (const fvPatch &p, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 fvPatchFieldBase (const fvPatchFieldBase &rhs, const fvPatch &p)
 Copy construct with new patch. More...
 
 fvPatchFieldBase (const fvPatchFieldBase &rhs)
 Copy construct. More...
 
virtual ~fvPatchFieldBase ()=default
 Destructor. More...
 
virtual bool coupled () const
 True if the patch field is coupled. More...
 
const objectRegistrydb () const
 The associated objectRegistry. More...
 
const fvPatchpatch () const noexcept
 Return the patch. More...
 
const wordpatchType () const noexcept
 The optional patch type. More...
 
wordpatchType () noexcept
 The optional patch type. More...
 
bool updated () const noexcept
 True if the boundary condition has already been updated. More...
 
bool manipulatedMatrix () const noexcept
 True if the matrix has already been manipulated. More...
 
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only. More...
 
bool useImplicit (bool on) noexcept
 Set useImplicit on/off. More...
 
void checkPatch (const fvPatchFieldBase &rhs) const
 Check that patches are identical. More...
 
- Public Member Functions inherited from Field< Type >
constexpr Field () noexcept
 Default construct. More...
 
 Field (const label len)
 Construct given size. More...
 
 Field (const label len, const Type &val)
 Construct given size and initial value. More...
 
 Field (const label len, const Foam::zero)
 Construct given size and initial values of zero. More...
 
 Field (const Foam::one, const Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 Field (const Foam::one, Type &&val)
 Construct with length=1, moving the value as the only content. More...
 
 Field (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 Field (const Field< Type > &fld)
 Copy construct. More...
 
 Field (const UList< Type > &list)
 Copy construct from UList<Type> More...
 
template<class Addr >
 Field (const IndirectListBase< Type, Addr > &list)
 Copy construct from IndirectList. More...
 
 Field (Field< Type > &&fld)
 Move construct from Field. More...
 
 Field (List< Type > &&list)
 Move construct from List. More...
 
template<int SizeMin>
 Field (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...
 
 Field (Field< Type > &fld, bool reuse)
 Copy construct or re-use as specified. More...
 
 Field (const tmp< Field< Type >> &tfld)
 Copy or move construct from tmp. More...
 
 Field (Istream &is)
 Construct from Istream. More...
 
 Field (const entry &e, const label len)
 Construct from a dictionary (primitive) entry. More...
 
 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(): More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void assign (const entry &e, const label len)
 Assign from a primitive dictionary entry with the following behaviour: More...
 
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). More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Inplace negate this field (negative). More...
 
void normalise ()
 Inplace normalise this field. Generally a no-op except for vector fields. More...
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
void clamp_min (const Type &lower)
 Impose lower (floor) clamp on the field values (in-place) More...
 
void clamp_max (const Type &upper)
 Impose upper (ceiling) clamp on the field values (in-place) More...
 
void clamp_range (const Type &lower, const Type &upper)
 Clamp field values (in-place) to the specified range. More...
 
void clamp_range (const MinMax< Type > &range)
 Clamp field values (in-place) to the specified range. More...
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
SubField< Type > slice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking. More...
 
const SubField< Type > slice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking. More...
 
SubField< Type > slice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking. More...
 
const SubField< Type > slice (const labelRange &range) const
 Return SubField slice (const access) - with range checking. More...
 
void operator= (const Field< Type > &)
 Copy assignment. More...
 
void operator= (const tmp< Field< Type >> &)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
template<class Addr >
void operator= (const IndirectListBase< Type, Addr > &rhs)
 Copy assign from IndirectList. More...
 
void operator= (Field< Type > &&rhs)
 Move assignment. More...
 
void operator= (List< Type > &&rhs)
 
template<int SizeMin>
void operator= (DynamicList< Type, SizeMin > &&rhs)
 
void operator= (const Type &val)
 Assign entries to the given value. More...
 
void operator= (const Foam::zero)
 Assign entries to zero. More...
 
template<class Form , class Cmpt , direction 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 Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 
template<class Type>
void operator= (const tmp< Field > &rhs)
 
template<>
void normalise ()
 
template<>
void normalise ()
 
template<>
void normalise ()
 Inplace normalise (float) vector field. More...
 
template<>
void normalise ()
 Inplace normalise (double) vector field. More...
 
- Public Member Functions inherited from FieldBase
constexpr FieldBase () noexcept
 Default construct. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int use_count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< Type >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const Type &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, Type &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< Type > &a)
 Copy construct from list. More...
 
 List (const UList< Type > &a)
 Copy construct contents from list. More...
 
 List (List< Type > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Type > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< Type > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< Type, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< Type > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Type > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< Type, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< Type > list)
 Construct from an initializer list. More...
 
 List (List< Type > &&list)
 Move construct from List. More...
 
 List (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< Type > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< Type > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const Type &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const Type &val)
 Alias for resize() More...
 
void transfer (List< Type > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< Type, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
Type & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
Type & emplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element. More...
 
void push_back (const Type &val)
 Append an element at the end of the list. More...
 
void push_back (Type &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< Type > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< Type, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const Type &val)
 Append an element if not already in the list. More...
 
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list. More...
 
void operator= (const UList< Type > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Type > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< Type, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< Type, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< Type > list)
 Assignment to an initializer list. More...
 
void operator= (const Type &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< Type > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< Type, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< Type > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 Specialized list reading for character lists which always uses binary format. More...
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< Type > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 
void append (const Type &val)
 Append an element at the end of the list. More...
 
void append (Type &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< Type > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< Type, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const Type &val)
 Append an element if not already in the list. More...
 
- Public Member Functions inherited from UList< Type >
label size () const noexcept
 The number of elements in the List. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
void operator= (const Type &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
 UList (const UList< Type > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (Type *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
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. More...
 
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. More...
 
const Type & fcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
Type & fcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const Type & rcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
Type & rcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Type * cdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Type * data () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
Type & front ()
 Access first element of the list, position [0]. More...
 
const Type & front () const
 Access first element of the list. More...
 
Type & back ()
 Access last element of the list, position [size()-1]. More...
 
const Type & back () const
 Access last element of the list, position [size()-1]. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
label find (const Type &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const Type &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool contains (const Type &val, label pos=0) const
 Is the value contained in the list? More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (const UList< Type > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< Type > &list)
 Copy elements of the given UList. Sizes must match! More...
 
void deepCopy (const IndirectListBase< Type, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Type > slice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Type > slice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Type > slice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Type > slice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Type & operator[] (const label i)
 Return element of UList. More...
 
const Type & operator[] (const label i) const
 Return element of constant UList. More...
 
const bool & operator[] (const label i) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
void swap (UList< Type > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< Type > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< Type > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< Type > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< Type > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< Type > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< Type > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
IstreamreadList (Istream &is)
 Specialized list reading for character lists which always uses binary format. More...
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
OstreamwriteList (Ostream &os, const label) const
 Specialized writeList for character lists which always uses binary format. More...
 
OstreamwriteList (Ostream &os, const label) const
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 Test bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 Return bool value at specified position, always false for out-of-range access. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access. More...
 
Type & first ()
 Access first element of the list, position [0]. More...
 
const Type & first () const
 Access first element of the list. More...
 
Type & last ()
 Access last element of the list, position [size()-1]. More...
 
const Type & last () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const Type &val, label pos=0) const
 Same as contains() More...
 

Additional Inherited Members

- Public Types inherited from fvPatchField< Type >
typedef DimensionedField< Type, volMeshInternal
 The internal field type associated with the patch field. More...
 
typedef fvPatch Patch
 The patch type for the patch field. More...
 
typedef calculatedFvPatchField< Type > Calculated
 Type for a calculated patch. More...
 
- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< Type >
typedef Type value_type
 The value type the list contains. More...
 
typedef Type * pointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Type * const_pointer
 The pointer type for const access to value_type items. More...
 
typedef Type & reference
 The type used for storing into value_type objects. More...
 
typedef const Type & const_reference
 The type used for reading from constant value_type objects. More...
 
typedef Type * iterator
 Random access iterator for traversing a UList. More...
 
typedef const Type * const_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 
- Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > > New (const word &patchFieldType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
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. More...
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
template<class Type2 >
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
- Static Public Member Functions inherited from fvPatchFieldBase
static const wordemptyType () noexcept
 The type name for empty patch fields. More...
 
static const wordcalculatedType () noexcept
 The type name for calculated patch fields. More...
 
static const wordextrapolatedCalculatedType () noexcept
 The type name for extrapolatedCalculated patch fields combines zero-gradient and calculated. More...
 
static const wordzeroGradientType () noexcept
 The type name for zeroGradient patch fields. More...
 
- Static Public Member Functions inherited from Field< Type >
static const Field< Type > & null ()
 Return nullObject reference Field. More...
 
static autoPtr< Field< Type > > New (Istream &is)
 Return a pointer to a new Field created on freestore. More...
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More...
 
- Static Public Member Functions inherited from List< Type >
static const List< Type > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< Type >
static const UList< Type > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Attributes inherited from fvPatchFieldBase
static int disallowGenericPatchField
 Debug switch to disallow the use of generic fvPatchField. More...
 
- Static Public Attributes inherited from FieldBase
static const char *const typeName
 Typename for Field. More...
 
static bool allowConstructFromLargerSize = false
 Permit read construct from a larger size. More...
 
- Protected Member Functions inherited from fvPatchField< Type >
bool readValueEntry (const dictionary &dict, IOobjectOption::readOption readOpt=IOobjectOption::LAZY_READ)
 Read the "value" entry into *this. More...
 
void writeValueEntry (Ostream &os) const
 Write *this field as a "value" entry. More...
 
void extrapolateInternal ()
 Assign the patch field from the internal field. More...
 
- Protected Member Functions inherited from fvPatchFieldBase
virtual void readDict (const dictionary &dict)
 Read dictionary entries. More...
 
void setUpdated (bool state) noexcept
 Set updated state. More...
 
void setManipulated (bool state) noexcept
 Set matrix manipulated state. More...
 
- Protected Member Functions inherited from UList< Type >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
void writeEntry (Ostream &os) const
 Specialized writeEntry for character lists which always uses binary format. More...
 
void writeEntry (Ostream &os) const
 
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. More...
 
UList< Type > & operator= (const UList< Type > &)=delete
 No copy assignment (default: shallow copy) More...
 

Detailed Description

template<class Type>
class Foam::directionMixedFvPatchField< Type >

Base class for direction-mixed boundary conditions.

Source files

Definition at line 50 of file directionMixedFvPatchField.H.

Constructor & Destructor Documentation

◆ directionMixedFvPatchField() [1/4]

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

Construct from patch and internal field.

Definition at line 28 of file directionMixedFvPatchField.C.

◆ directionMixedFvPatchField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 68 of file directionMixedFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ directionMixedFvPatchField() [3/4]

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

Construct by mapping given directionMixedFvPatchField onto.

a new patch

Definition at line 42 of file directionMixedFvPatchField.C.

References Foam::endl(), FieldMapper::hasUnmapped(), Foam::nl, Foam::notNull(), p, and WarningInFunction.

Here is the call graph for this function:

◆ directionMixedFvPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 85 of file directionMixedFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "directionMixed"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements transformFvPatchField< Type >.

Definition at line 117 of file directionMixedFvPatchField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Implements transformFvPatchField< Type >.

Definition at line 138 of file directionMixedFvPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

True: this patch field fixes a value.

Reimplemented from fvPatchFieldBase.

Definition at line 154 of file directionMixedFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

False: this patch field is not altered by assignment.

Reimplemented from transformFvPatchField< Type >.

Definition at line 159 of file directionMixedFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Reimplemented from fvPatchField< Type >.

Definition at line 101 of file directionMixedFvPatchField.C.

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 114 of file directionMixedFvPatchField.C.

References directionMixedFvPatchField< Type >::rmap().

Referenced by directionMixedFvPatchField< Type >::rmap().

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

◆ refValue() [1/2]

virtual Field<Type>& refValue ( )
inlinevirtual

Definition at line 184 of file directionMixedFvPatchField.H.

◆ refValue() [2/2]

virtual const Field<Type>& refValue ( ) const
inlinevirtual

Definition at line 189 of file directionMixedFvPatchField.H.

◆ refGrad() [1/2]

virtual Field<Type>& refGrad ( )
inlinevirtual

Definition at line 194 of file directionMixedFvPatchField.H.

◆ refGrad() [2/2]

virtual const Field<Type>& refGrad ( ) const
inlinevirtual

Definition at line 199 of file directionMixedFvPatchField.H.

◆ valueFraction() [1/2]

virtual symmTensorField& valueFraction ( )
inlinevirtual

Definition at line 204 of file directionMixedFvPatchField.H.

◆ valueFraction() [2/2]

virtual const symmTensorField& valueFraction ( ) const
inlinevirtual

Definition at line 209 of file directionMixedFvPatchField.H.

◆ snGrad()

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

Return gradient at boundary.

Implements transformFvPatchField< Type >.

Definition at line 132 of file directionMixedFvPatchField.C.

References Foam::I, Foam::foamVersion::patch, and Foam::transform().

Here is the call graph for this function:

◆ evaluate()

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

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 150 of file directionMixedFvPatchField.C.

References Foam::stringOps::evaluate(), Foam::I, Foam::foamVersion::patch, and Foam::transform().

Here is the call graph for this function:

◆ snGradTransformDiag()

Foam::tmp< Foam::Field< Type > > snGradTransformDiag ( ) const
virtual

Return face-gradient transform diagonal.

Implements transformFvPatchField< Type >.

Definition at line 173 of file directionMixedFvPatchField.C.

References Foam::diag(), Foam::mag(), Foam::sqrt(), and Y.

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 198 of file directionMixedFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

◆ operator=() [1/3]

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

Reimplemented from transformFvPatchField< Type >.

Definition at line 245 of file directionMixedFvPatchField.H.

◆ operator+=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 246 of file directionMixedFvPatchField.H.

◆ operator-=() [1/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 247 of file directionMixedFvPatchField.H.

◆ operator*=() [1/3]

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

Definition at line 248 of file directionMixedFvPatchField.H.

◆ operator/=() [1/3]

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

Definition at line 249 of file directionMixedFvPatchField.H.

◆ operator=() [2/3]

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

Definition at line 251 of file directionMixedFvPatchField.H.

◆ operator+=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 252 of file directionMixedFvPatchField.H.

◆ operator-=() [2/3]

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

Reimplemented from fvPatchField< Type >.

Definition at line 253 of file directionMixedFvPatchField.H.

◆ operator*=() [2/3]

virtual void operator*= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 254 of file directionMixedFvPatchField.H.

◆ operator/=() [2/3]

virtual void operator/= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 255 of file directionMixedFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 257 of file directionMixedFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 258 of file directionMixedFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 259 of file directionMixedFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 260 of file directionMixedFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 261 of file directionMixedFvPatchField.H.


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