Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Friends
pointPatchField Class Referenceabstract

Abstract base class for point-mesh patch fields. More...

Inheritance diagram for pointPatchField:
Inheritance graph
[legend]
Collaboration diagram for pointPatchField:
Collaboration graph
[legend]

Public Types

typedef pointPatch Patch
 

Public Member Functions

 TypeName ("pointPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)
 Construct as copy. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const =0
 Construct and return a clone. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const =0
 Construct and return a clone setting internal field reference. More...
 
virtual ~pointPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
label size () const
 Return size. More...
 
const pointPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, pointMesh > & dimensionedInternalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & internalField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate internal field values. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatchField implements. More...
 
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const pointPatchField< Type > &, const labelList &)
 Reverse map the given pointPatchField onto this pointPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const pointPatchField< Type > &)
 
virtual void operator+= (const pointPatchField< Type > &)
 
virtual void operator-= (const pointPatchField< Type > &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
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)
 
virtual void operator== (const pointPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type >
tmp< Field< Type > > patchInternalField () const
 

Static Public Member Functions

static autoPtr< pointPatchField< Type > > New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
template<class Type2 >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new CalculatedpointPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 

Static Public Attributes

static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. More...
 

Private Attributes

const pointPatchpatch_
 Reference to patch. More...
 
const DimensionedField< Type, pointMesh > & internalField_
 Reference to internal field. More...
 
bool updated_
 Update index used so that updateCoeffs is called only once during. More...
 
word patchType_
 Optional patch type, used to allow specified boundary conditions. More...
 

Friends

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

Detailed Description

Abstract base class for point-mesh patch fields.

The base-field does not store values as they are part of the "internal field". There are derived classes to store constraint values e.g. fixedValuePointPatchField derived from the generic valuePointPatchField which ensures the values in the "internal field" are reset to the fixed-values by applying the stored values.

Source files

Definition at line 58 of file pointMVCWeight.H.

Member Typedef Documentation

◆ Patch

typedef pointPatch Patch

Definition at line 100 of file pointPatchField.H.

Constructor & Destructor Documentation

◆ pointPatchField() [1/5]

pointPatchField ( const pointPatch ,
const DimensionedField< Type, pointMesh > &   
)

Construct from patch and internal field.

◆ pointPatchField() [2/5]

pointPatchField ( const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const dictionary  
)

Construct from patch, internal field and dictionary.

◆ pointPatchField() [3/5]

pointPatchField ( const pointPatchField< Type > &  ,
const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const pointPatchFieldMapper  
)

Construct by mapping given patchField<Type> onto a new patch.

◆ pointPatchField() [4/5]

pointPatchField ( const pointPatchField< Type > &  )

Construct as copy.

◆ pointPatchField() [5/5]

pointPatchField ( const pointPatchField< Type > &  ,
const DimensionedField< Type, pointMesh > &   
)

Construct as copy setting internal field reference.

◆ ~pointPatchField()

virtual ~pointPatchField ( )
inlinevirtual

Destructor.

Definition at line 253 of file pointPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "pointPatchField"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable ( autoPtr  ,
pointPatchField  ,
pointPatch  ,
(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)  ,
(p, iF)   
)

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable ( autoPtr  ,
pointPatchField  ,
patchMapper  ,
(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m)  ,
(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m)   
)

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable ( autoPtr  ,
pointPatchField  ,
dictionary  ,
(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict ,
(p, iF, dict  
)

◆ clone() [1/2]

virtual autoPtr<pointPatchField<Type> > clone ( ) const
pure virtual

◆ clone() [2/2]

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > &  iF) const
pure virtual

◆ New() [1/4]

static autoPtr<pointPatchField<Type> > New ( const word ,
const pointPatch ,
const DimensionedField< Type, pointMesh > &   
)
static

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

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

◆ New() [2/4]

static autoPtr<pointPatchField<Type> > New ( const word ,
const word actualPatchType,
const pointPatch ,
const DimensionedField< Type, pointMesh > &   
)
static

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

patch and internal field (does not set the patch field values). Allows override of constraint type

◆ New() [3/4]

static autoPtr<pointPatchField<Type> > New ( const pointPatchField< Type > &  ,
const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const pointPatchFieldMapper  
)
static

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

a given pointPatchField mapped onto a new patch

◆ New() [4/4]

static autoPtr<pointPatchField<Type> > New ( const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const dictionary  
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

◆ NewCalculatedType()

autoPtr< pointPatchField< Type > > NewCalculatedType ( const pointPatchField< Type2 > &  pf)
static

Return a pointer to a new CalculatedpointPatchField created on.

freestore without setting patchField values

Definition at line 93 of file calculatedPointPatchField.C.

◆ db()

const objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 112 of file pointPatchField.C.

Referenced by surfaceSlipDisplacementPointPatchVectorField::surfaces().

Here is the caller graph for this function:

◆ size()

label size ( ) const
inline

Return size.

Definition at line 265 of file pointPatchField.H.

◆ patch()

const pointPatch& patch ( ) const
inline

Return patch.

Definition at line 271 of file pointPatchField.H.

Referenced by pointPatchField< Type >::NewCalculatedType(), patchCorrectedInterpolation::propagateDataFromPatchGroup(), and pointPatchField< Type >::size().

Here is the caller graph for this function:

◆ dimensionedInternalField()

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

Return dimensioned internal field reference.

Definition at line 278 of file pointPatchField.H.

◆ internalField()

const Field<Type>& internalField ( ) const
inline

Return internal field reference.

Definition at line 284 of file pointPatchField.H.

◆ patchType() [1/2]

const word& patchType ( ) const
inline

Optional patch type.

Definition at line 290 of file pointPatchField.H.

◆ patchType() [2/2]

word& patchType ( )
inline

Optional patch type.

Definition at line 296 of file pointPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Reimplemented in fixedValuePointPatchField< vector >.

Definition at line 302 of file pointPatchField.H.

Referenced by medialAxisMeshMover::update().

Here is the caller graph for this function:

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is coupled.

Definition at line 308 of file pointPatchField.H.

◆ updated()

bool updated ( ) const
inline

Return true if the boundary condition has already been updated.

Definition at line 314 of file pointPatchField.H.

◆ patchInternalField() [1/4]

tmp<Field<Type> > patchInternalField ( ) const

◆ patchInternalField() [2/4]

tmp< Field< Type1 > > patchInternalField ( const Field< Type1 > &  iF) const

Return field created from appropriate internal field values.

given internal field reference

Definition at line 163 of file pointPatchField.C.

◆ patchInternalField() [3/4]

tmp< Field< Type1 > > patchInternalField ( const Field< Type1 > &  iF,
const labelList meshPoints 
) const

Return field created from selected internal field values.

given internal field reference

Definition at line 141 of file pointPatchField.C.

◆ addToInternalField() [1/2]

void addToInternalField ( Field< Type1 > &  iF,
const Field< Type1 > &  pF 
) const

Given the internal field and a patch field,.

add the patch field to the internal field

Definition at line 174 of file pointPatchField.C.

◆ addToInternalField() [2/2]

void addToInternalField ( Field< Type1 > &  iF,
const Field< Type1 > &  pF,
const labelList points 
) const

Given the internal field and a patch field,.

add selected elements of the patch field to the internal field

Definition at line 211 of file pointPatchField.C.

◆ setInInternalField() [1/2]

void setInInternalField ( Field< Type1 > &  iF,
const Field< Type1 > &  pF,
const labelList meshPoints 
) const

Given the internal field and a patch field,.

set the patch field in the internal field

Definition at line 250 of file pointPatchField.C.

◆ setInInternalField() [2/2]

void setInInternalField ( Field< Type1 > &  iF,
const Field< Type1 > &  pF 
) const

Given the internal field and a patch field,.

set the patch field in the internal field

Definition at line 285 of file pointPatchField.C.

◆ calculatedType()

const word & calculatedType ( )
static

Return the type of the calculated form of pointPatchField.

Definition at line 34 of file calculatedPointPatchField.C.

◆ constraintType()

virtual const word& constraintType ( ) const
inlinevirtual

Return the constraint type this pointPatchField implements.

Definition at line 381 of file pointPatchField.H.

◆ autoMap()

virtual void autoMap ( const pointPatchFieldMapper )
inlinevirtual

◆ rmap()

virtual void rmap ( const pointPatchField< Type > &  ,
const labelList  
)
inlinevirtual

◆ updateCoeffs()

virtual void updateCoeffs ( )
inlinevirtual

◆ initEvaluate()

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

Initialise evaluation of the patch field (do nothing)

Definition at line 416 of file pointPatchField.H.

◆ evaluate()

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

◆ write()

void write ( Ostream os) const
virtual

◆ operator=() [1/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 435 of file pointPatchField.H.

◆ operator+=() [1/3]

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

Definition at line 441 of file pointPatchField.H.

◆ operator-=() [1/3]

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

Definition at line 447 of file pointPatchField.H.

◆ operator*=() [1/3]

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

Definition at line 453 of file pointPatchField.H.

◆ operator/=() [1/3]

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

Definition at line 459 of file pointPatchField.H.

◆ operator=() [2/3]

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

Reimplemented in valuePointPatchField< Type >, and fixedValuePointPatchField< Type >.

Definition at line 464 of file pointPatchField.H.

◆ operator+=() [2/3]

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

Definition at line 465 of file pointPatchField.H.

◆ operator-=() [2/3]

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

Definition at line 466 of file pointPatchField.H.

◆ operator*=() [2/3]

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

Definition at line 468 of file pointPatchField.H.

◆ operator/=() [2/3]

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

Definition at line 469 of file pointPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented in valuePointPatchField< Type >, and fixedValuePointPatchField< Type >.

Definition at line 471 of file pointPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Definition at line 472 of file pointPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Definition at line 473 of file pointPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Definition at line 474 of file pointPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Definition at line 475 of file pointPatchField.H.

◆ operator==() [1/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 483 of file pointPatchField.H.

◆ operator==() [2/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 488 of file pointPatchField.H.

◆ operator==() [3/3]

virtual void operator== ( const Type &  )
inlinevirtual

Reimplemented in valuePointPatchField< Type >.

Definition at line 489 of file pointPatchField.H.

◆ patchInternalField() [4/4]

tmp<Field<Type> > patchInternalField ( ) const

Definition at line 132 of file pointPatchField.C.

Friends And Related Function Documentation

◆ operator

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

Field Documentation

◆ patch_

const pointPatch& patch_
private

Reference to patch.

Definition at line 83 of file pointPatchField.H.

Referenced by pointPatchField< Type >::patch().

◆ internalField_

const DimensionedField<Type, pointMesh>& internalField_
private

Reference to internal field.

Definition at line 86 of file pointPatchField.H.

Referenced by pointPatchField< Type >::dimensionedInternalField(), and pointPatchField< Type >::internalField().

◆ updated_

bool updated_
private

Update index used so that updateCoeffs is called only once during.

the construction of the matrix

Definition at line 90 of file pointPatchField.H.

Referenced by pointPatchField< Type >::updated().

◆ patchType_

word patchType_
private

Optional patch type, used to allow specified boundary conditions.

to be applied to constraint patches by providing the constraint patch type as 'patchType'

Definition at line 95 of file pointPatchField.H.

Referenced by pointPatchField< Type >::patchType().

◆ disallowGenericPointPatchField

int disallowGenericPointPatchField
static

Debug switch to disallow the use of genericPointPatchField.

Definition at line 107 of file pointPatchField.H.


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