Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
pointPatchField< Type > Class Template Referenceabstract

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

Inheritance diagram for pointPatchField< Type >:
Inheritance 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 &)
 

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...
 

Friends

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

Detailed Description

template<class Type>
class Foam::pointPatchField< Type >

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

typedef pointPatch Patch

Definition at line 100 of file pointPatchField.H.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 39 of file pointPatchField.C.

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

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 53 of file pointPatchField.C.

References pointPatchField< Type >::pointPatchField().

Here is the call graph for this function:

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

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

Definition at line 68 of file pointPatchField.C.

References pointPatchField< Type >::pointPatchField().

Here is the call graph for this function:

pointPatchField ( const pointPatchField< Type > &  ptf)

Construct as copy.

Definition at line 84 of file pointPatchField.C.

References pointPatchField< Type >::pointPatchField().

Here is the call graph for this function:

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

Construct as copy setting internal field reference.

Definition at line 97 of file pointPatchField.C.

virtual ~pointPatchField ( )
inlinevirtual

Destructor.

Definition at line 253 of file pointPatchField.H.

Member Function Documentation

TypeName ( "pointPatchField< Type >"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
pointPatchField< Type >  ,
pointPatch  ,
( const pointPatch &p, const DimensionedField< Type, pointMesh > &iF )  ,
(p, iF)   
)
declareRunTimeSelectionTable ( autoPtr  ,
pointPatchField< Type >  ,
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< Type >  ,
dictionary  ,
( const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict ,
(p, iF, dict  
)
virtual autoPtr<pointPatchField<Type> > clone ( ) const
pure virtual
virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > &  iF) const
pure virtual
Foam::autoPtr< Foam::pointPatchField< Type > > New ( const word patchFieldType,
const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF 
)
static

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

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

Definition at line 108 of file pointPatchFieldNew.C.

References Foam::compressible::New().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const word patchFieldType,
const word actualPatchType,
const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF 
)
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

Definition at line 32 of file pointPatchFieldNew.C.

References pointPatch::constraintType(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, pointPatchField< Type >::New(), Foam::nl, and p.

Here is the call graph for this function:

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const pointPatchField< Type > &  ptf,
const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF,
const pointPatchFieldMapper pfMapper 
)
static

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

a given pointPatchField mapped onto a new patch

Definition at line 206 of file pointPatchFieldNew.C.

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

Here is the call graph for this function:

Foam::autoPtr< Foam::pointPatchField< Type > > New ( const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF,
const dictionary dict 
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 120 of file pointPatchFieldNew.C.

References pointPatch::constraintType(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), pointPatchField< Type >::New(), Foam::nl, and p.

Here is the call graph for this function:

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.

References Field< Type >::null(), and pointPatchField< Type >::patch().

Referenced by calculatedPointPatchField< Type >::calculatedPointPatchField().

Here is the call graph for this function:

Here is the caller graph for this function:

const objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 112 of file pointPatchField.C.

Referenced by surfaceSlipDisplacementPointPatchVectorField::surfaces(), and pointPatchField< vector >::~pointPatchField().

Here is the caller graph for this function:

label size ( ) const
inline

Return size.

Definition at line 265 of file pointPatchField.H.

Referenced by valuePointPatchField< Type >::valuePointPatchField().

Here is the caller graph for this function:

const pointPatch& patch ( ) const
inline

Return patch.

Definition at line 271 of file pointPatchField.H.

Referenced by NamedEnum< Enum, nEnum >::names(), pointPatchField< Type >::NewCalculatedType(), and pointPatchField< vector >::size().

Here is the caller graph for this function:

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

Return dimensioned internal field reference.

Definition at line 278 of file pointPatchField.H.

const Field<Type>& internalField ( ) const
inline

Return internal field reference.

Definition at line 284 of file pointPatchField.H.

Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate().

Here is the caller graph for this function:

const word& patchType ( ) const
inline

Optional patch type.

Definition at line 290 of file pointPatchField.H.

word& patchType ( )
inline

Optional patch type.

Definition at line 296 of file pointPatchField.H.

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

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

Definition at line 302 of file pointPatchField.H.

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is coupled.

Reimplemented in processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and coupledPointPatchField< Type >.

Definition at line 308 of file pointPatchField.H.

bool updated ( ) const
inline

Return true if the boundary condition has already been updated.

Definition at line 314 of file pointPatchField.H.

tmp< Field< Type > > patchInternalField ( ) const

Return field created from appropriate internal field values.

Definition at line 132 of file pointPatchField.C.

References internalField().

Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate(), valuePointPatchField< Type >::operator=(), valuePointPatchField< Type >::operator==(), pointPatchField< Type >::patchInternalField(), pointConstraints::setPatchFields(), and pointPatchField< vector >::updated().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return field created from appropriate internal field values.

given internal field reference

Definition at line 167 of file pointPatchField.C.

References pointPatchField< Type >::addToInternalField().

Here is the call graph for this function:

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.

References Foam::abort(), Foam::FatalError, FatalErrorIn, internalField(), pointPatchField< Type >::patchInternalField(), and List< Type >::size().

Here is the call graph for this function:

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 178 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, internalField(), Foam::constant::atomic::mp, and List< Type >::size().

Referenced by pointPatchField< Type >::patchInternalField(), and pointPatchField< vector >::updated().

Here is the call graph for this function:

Here is the caller graph for this function:

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 223 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, internalField(), Foam::constant::atomic::mp, pointPatchField< Type >::setInInternalField(), and List< Type >::size().

Here is the call graph for this function:

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 270 of file pointPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, internalField(), List< T >::size(), and List< Type >::size().

Referenced by pointPatchField< Type >::addToInternalField(), surfaceSlipDisplacementPointPatchVectorField::evaluate(), and pointPatchField< vector >::updated().

Here is the call graph for this function:

Here is the caller graph for this function:

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 313 of file pointPatchField.C.

const word & calculatedType ( )
static

Return the type of the calculated form of pointPatchField.

Definition at line 34 of file calculatedPointPatchField.C.

References calculatedPointPatchField< Type >::calculatedPointPatchField().

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

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const word& constraintType ( ) const
inlinevirtual
virtual void autoMap ( const pointPatchFieldMapper )
inlinevirtual
virtual void rmap ( const pointPatchField< Type > &  ,
const labelList  
)
inlinevirtual
virtual void updateCoeffs ( )
inlinevirtual
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.

Referenced by pointPatchField< vector >::rmap().

Here is the caller graph for this function:

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

Write.

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

Definition at line 119 of file pointPatchField.C.

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

Referenced by pointPatchField< vector >::initEvaluate(), Foam::operator<<(), oscillatingDisplacementPointPatchVectorField::write(), waveDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), and sixDoFRigidBodyDisplacementPointPatchVectorField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Definition at line 435 of file pointPatchField.H.

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

Definition at line 441 of file pointPatchField.H.

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

Definition at line 447 of file pointPatchField.H.

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

Definition at line 453 of file pointPatchField.H.

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

Definition at line 459 of file pointPatchField.H.

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

Definition at line 465 of file pointPatchField.H.

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

Definition at line 466 of file pointPatchField.H.

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

Definition at line 468 of file pointPatchField.H.

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

Definition at line 469 of file pointPatchField.H.

virtual void operator= ( const Type &  )
inlinevirtual
virtual void operator+= ( const Type &  )
inlinevirtual

Definition at line 472 of file pointPatchField.H.

virtual void operator-= ( const Type &  )
inlinevirtual

Definition at line 473 of file pointPatchField.H.

virtual void operator*= ( const scalar  )
inlinevirtual

Definition at line 474 of file pointPatchField.H.

virtual void operator/= ( const scalar  )
inlinevirtual

Definition at line 475 of file pointPatchField.H.

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

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

Definition at line 483 of file pointPatchField.H.

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

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

Definition at line 488 of file pointPatchField.H.

virtual void operator== ( const Type &  )
inlinevirtual

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

Definition at line 489 of file pointPatchField.H.

Friends And Related Function Documentation

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

Member Data Documentation

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: