Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
pointPatchField Class Referenceabstract

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

Inheritance diagram for pointPatchField:
Inheritance graph
[legend]

Public Types

typedef Type value_type
 
typedef pointPatch Patch
 
typedef calculatedPointPatchField< Type > Calculated
 

Public Member Functions

 TypeName ("pointPatchField")
 
 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 > &)
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 
 pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 
 pointPatchField (const pointPatchField< Type > &)
 
virtual autoPtr< pointPatchField< Type > > clone () const =0
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const =0
 
virtual ~pointPatchField ()=default
 
const objectRegistry & db () const
 
label size () const
 
const pointPatch & patch () const
 
const DimensionedField< Type, pointMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const word & patchType () const
 
word & patchType ()
 
virtual bool fixesValue () const
 
virtual bool coupled () const
 
bool updated () const
 
tmp< Field< Type > > patchInternalField () const
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 
virtual const word & constraintType () const
 
virtual void autoMap (const pointPatchFieldMapper &)
 
virtual void rmap (const pointPatchField< Type > &, const labelList &)
 
virtual void updateCoeffs ()
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual void write (Ostream &) const
 
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 &)
 
void negate ()
 
template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &pf)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField () const
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 

Static Public Member Functions

static autoPtr< pointPatchField< Type > > New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 
static autoPtr< pointPatchField< Type > > New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 
static autoPtr< pointPatchField< Type > > New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 
static autoPtr< pointPatchField< Type > > New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 
template<class Type2 >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 
static const word & calculatedType ()
 

Static Public Attributes

static int disallowGenericPointPatchField
 

Friends

Ostream & operator (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 56 of file pointMVCWeight.H.

Member Typedef Documentation

◆ value_type

typedef Type value_type

Definition at line 93 of file pointPatchField.H.

◆ Patch

typedef pointPatch Patch

Definition at line 94 of file pointPatchField.H.

◆ Calculated

typedef calculatedPointPatchField<Type> Calculated

Definition at line 95 of file pointPatchField.H.

Constructor & Destructor Documentation

◆ pointPatchField() [1/5]

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

◆ pointPatchField() [2/5]

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

◆ pointPatchField() [3/5]

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

◆ pointPatchField() [4/5]

pointPatchField ( const pointPatchField< Type > &  )

◆ pointPatchField() [5/5]

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

◆ ~pointPatchField()

virtual ~pointPatchField ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "pointPatchField"  )

◆ 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

Implemented in surfaceSlipDisplacementPointPatchVectorField, valuePointPatchField< vector >, and fixedValuePointPatchField< vector >.

◆ clone() [2/2]

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

Implemented in coupledPointPatchField< Type >, codedFixedValuePointPatchField< Type >, cyclicACMIPointPatchField< Type >, cyclicAMIPointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, exprValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, zeroFixedValuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, genericPointPatchField< Type >, processorCyclicPointPatchField< Type >, valuePointPatchField< Type >, cyclicPointPatchField< Type >, symmetryPlanePointPatchField< Type >, processorPointPatchField< Type >, calculatedPointPatchField< Type >, fixedValuePointPatchField< Type >, cyclicSlipPointPatchField< Type >, emptyPointPatchField< Type >, nonuniformTransformCyclicPointPatchField< Type >, symmetryPointPatchField< Type >, wedgePointPatchField< Type >, zeroGradientPointPatchField< Type >, slipPointPatchField< Type >, and basicSymmetryPointPatchField< Type >.

◆ New() [1/4]

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

◆ New() [2/4]

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

◆ New() [3/4]

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

◆ New() [4/4]

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

◆ NewCalculatedType() [1/2]

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

◆ db()

const Foam::objectRegistry & db ( ) const

Definition at line 103 of file pointPatchField.C.

◆ size()

label size ( ) const
inline

Definition at line 258 of file pointPatchField.H.

◆ patch()

const pointPatch& patch ( ) const
inline

Definition at line 264 of file pointPatchField.H.

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

Here is the caller graph for this function:

◆ internalField()

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

Definition at line 271 of file pointPatchField.H.

◆ primitiveField()

const Field<Type>& primitiveField ( ) const
inline

Definition at line 277 of file pointPatchField.H.

◆ patchType() [1/2]

const word& patchType ( ) const
inline

Definition at line 283 of file pointPatchField.H.

◆ patchType() [2/2]

word& patchType ( )
inline

Definition at line 289 of file pointPatchField.H.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Reimplemented in fixedValuePointPatchField< vector >.

Definition at line 295 of file pointPatchField.H.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Definition at line 301 of file pointPatchField.H.

◆ updated()

bool updated ( ) const
inline

Definition at line 307 of file pointPatchField.H.

◆ patchInternalField() [1/6]

tmp<Field<Type> > patchInternalField ( ) const

Referenced by pointConstraints::setPatchFields(), and velocityDisplacementMotionSolver::solve().

Here is the caller graph for this function:

◆ patchInternalField() [2/6]

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

◆ patchInternalField() [3/6]

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

◆ addToInternalField() [1/2]

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

Definition at line 167 of file pointPatchField.C.

◆ addToInternalField() [2/2]

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

Definition at line 204 of file pointPatchField.C.

◆ setInInternalField() [1/2]

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

Definition at line 243 of file pointPatchField.C.

◆ setInInternalField() [2/2]

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

Definition at line 278 of file pointPatchField.C.

◆ calculatedType()

const Foam::word & calculatedType ( )
static

Definition at line 27 of file calculatedPointPatchField.C.

◆ constraintType()

virtual const word& constraintType ( ) const
inlinevirtual

Definition at line 374 of file pointPatchField.H.

◆ autoMap()

virtual void autoMap ( const pointPatchFieldMapper &  )
inlinevirtual

Reimplemented in timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, genericPointPatchField< Type >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, and oscillatingVelocityPointPatchVectorField.

Definition at line 384 of file pointPatchField.H.

◆ rmap()

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

Reimplemented in timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, valuePointPatchField< Type >, and genericPointPatchField< Type >.

Definition at line 391 of file pointPatchField.H.

◆ updateCoeffs()

virtual void updateCoeffs ( )
inlinevirtual

Reimplemented in waveMakerPointPatchVectorField, codedFixedValuePointPatchField< Type >, lumpedPointDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, exprValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, timeVaryingUniformFixedValuePointPatchField< Type >, waveDisplacementPointPatchVectorField, and oscillatingDisplacementPointPatchVectorField.

Definition at line 402 of file pointPatchField.H.

◆ initEvaluate()

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

Definition at line 409 of file pointPatchField.H.

◆ evaluate()

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

Reimplemented in coupledPointPatchField< Type >, codedFixedValuePointPatchField< Type >, cyclicAMIPointPatchField< Type >, cyclicACMIPointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, processorPointPatchField< Type >, processorCyclicPointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, cyclicPointPatchField< Type >, symmetryPlanePointPatchField< Type >, wedgePointPatchField< Type >, cyclicSlipPointPatchField< Type >, nonuniformTransformCyclicPointPatchField< Type >, and basicSymmetryPointPatchField< Type >.

Definition at line 288 of file pointPatchField.C.

Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Reimplemented in lumpedPointDisplacementPointPatchVectorField, exprValuePointPatchField< Type >, waveMakerPointPatchVectorField, codedFixedValuePointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uniformInterpolatedDisplacementPointPatchVectorField, valuePointPatchField< Type >, valuePointPatchField< vector >, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, timeVaryingUniformFixedValuePointPatchField< Type >, waveDisplacementPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, and genericPointPatchField< Type >.

Definition at line 110 of file pointPatchField.C.

Referenced by oscillatingDisplacementPointPatchVectorField::write(), waveDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), sixDoFRigidBodyDisplacementPointPatchVectorField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), lumpedPointDisplacementPointPatchVectorField::write(), and waveMakerPointPatchVectorField::write().

Here is the caller graph for this function:

◆ operator=() [1/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 431 of file pointPatchField.H.

◆ operator+=() [1/3]

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

Definition at line 432 of file pointPatchField.H.

◆ operator-=() [1/3]

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

Definition at line 433 of file pointPatchField.H.

◆ operator*=() [1/3]

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

Definition at line 434 of file pointPatchField.H.

◆ operator/=() [1/3]

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

Definition at line 435 of file pointPatchField.H.

◆ operator=() [2/3]

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

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

Definition at line 437 of file pointPatchField.H.

◆ operator+=() [2/3]

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

Definition at line 438 of file pointPatchField.H.

◆ operator-=() [2/3]

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

Definition at line 439 of file pointPatchField.H.

◆ operator*=() [2/3]

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

Definition at line 441 of file pointPatchField.H.

◆ operator/=() [2/3]

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

Definition at line 442 of file pointPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

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

Definition at line 444 of file pointPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Definition at line 445 of file pointPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Definition at line 446 of file pointPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Definition at line 447 of file pointPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Definition at line 448 of file pointPatchField.H.

◆ operator==() [1/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 455 of file pointPatchField.H.

◆ operator==() [2/3]

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

Reimplemented in valuePointPatchField< Type >.

Definition at line 456 of file pointPatchField.H.

◆ operator==() [3/3]

virtual void operator== ( const Type &  )
inlinevirtual

Reimplemented in valuePointPatchField< Type >.

Definition at line 457 of file pointPatchField.H.

◆ negate()

void negate ( )
inline

Definition at line 476 of file pointPatchField.H.

◆ NewCalculatedType() [2/2]

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

Definition at line 86 of file calculatedPointPatchField.C.

◆ patchInternalField() [4/6]

Foam::tmp<Foam::Field<Type> > patchInternalField ( ) const

Definition at line 123 of file pointPatchField.C.

◆ patchInternalField() [5/6]

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

Definition at line 133 of file pointPatchField.C.

◆ patchInternalField() [6/6]

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

Definition at line 156 of file pointPatchField.C.

Friends And Related Function Documentation

◆ operator

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

Member Data Documentation

◆ disallowGenericPointPatchField

int disallowGenericPointPatchField
static

Definition at line 102 of file pointPatchField.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17