Public Member Functions | Private Attributes
sixDoFRigidBodyDisplacementPointPatchVectorField Class Reference

Foam::sixDoFRigidBodyDisplacementPointPatchVectorField. More...

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

Public Member Functions

 TypeName ("sixDoFRigidBodyDisplacement")
 Runtime type information. More...
 
 sixDoFRigidBodyDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 sixDoFRigidBodyDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 sixDoFRigidBodyDisplacementPointPatchVectorField (const sixDoFRigidBodyDisplacementPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<vector> onto a new patch. More...
 
virtual autoPtr< pointPatchField< vector > > clone () const
 Construct and return a clone. More...
 
 sixDoFRigidBodyDisplacementPointPatchVectorField (const sixDoFRigidBodyDisplacementPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< vector > > clone (const DimensionedField< vector, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const pointPatchField< vector > &, 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 write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from fixedValuePointPatchField< vector >
 TypeName ("fixedValue")
 Runtime type information. More...
 
 fixedValuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 fixedValuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 fixedValuePointPatchField (const fixedValuePointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 fixedValuePointPatchField (const fixedValuePointPatchField< vector > &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< vector > > clone () const
 Construct and return a clone. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual void operator= (const Field< vector > &)
 
virtual void operator= (const vector &)
 
- Public Member Functions inherited from valuePointPatchField< vector >
 TypeName ("value")
 Runtime type information. More...
 
 valuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 valuePointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &, const bool valueRequired=true)
 Construct from patch, internal field and dictionary. More...
 
 valuePointPatchField (const valuePointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 valuePointPatchField (const valuePointPatchField< vector > &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
label size () const
 Return size. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field. More...
 
virtual void operator= (const valuePointPatchField< vector > &)
 
virtual void operator= (const pointPatchField< vector > &)
 
virtual void operator== (const valuePointPatchField< vector > &)
 
virtual void operator== (const pointPatchField< vector > &)
 
virtual void operator== (const Field< vector > &)
 
virtual void operator== (const vector &)
 
- Public Member Functions inherited from pointPatchField< vector >
 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...
 
 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 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...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
tmp< Field< Type > > patchInternalField () const
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
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 rmap (const pointPatchField< Type > &, const labelList &)
 Reverse map the given pointPatchField onto this pointPatchField. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void operator= (const pointPatchField< Type > &)
 
virtual void operator= (const Field< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const pointPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const pointPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const pointPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
- Public Member Functions inherited from Field< vector >
 Field ()
 Construct null. More...
 
 Field (const label)
 Construct given size. More...
 
 Field (const label, const Type &)
 Construct given size and initial value. More...
 
 Field (const UList< Type > &)
 Construct as copy of a UList<Type> More...
 
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents. 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. Supplied uniform. 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. Supplied values. More...
 
 Field (const Field< Type > &)
 Construct as copy. More...
 
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents. More...
 
 Field (const tmp< Field< Type > > &)
 Construct as copy of tmp<Field> More...
 
 Field (Istream &)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &, const label size)
 Construct from a dictionary entry. More...
 
tmp< Field< Type > > clone () const
 Clone. 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 ()
 Negate this field. 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...
 
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...
 
void operator= (const Field< Type > &)
 
void operator= (const UList< Type > &)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type > > &)
 
void operator= (const Type &)
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator= (const Field< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const tmp< Field > &rhs)
 
void operator= (const Type &t)
 
void operator+= (const UList< Type > &)
 
void operator+= (const tmp< Field< Type > > &)
 
void operator+= (const Type &)
 
void operator-= (const UList< Type > &)
 
void operator-= (const tmp< Field< Type > > &)
 
void operator-= (const Type &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar > > &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar > > &)
 
void operator/= (const scalar &)
 

Private Attributes

sixDoFRigidBodyMotion motion_
 Six dof motion object. More...
 
pointField initialPoints_
 Initial positions of points on the patch. More...
 
scalar rhoInf_
 Reference density required by the forces object for. More...
 
word rhoName_
 Name of density field, optional unless used for an. More...
 
label lookupGravity_
 State of gravity lookup: More...
 
vector g_
 Gravity vector to store when not available from the db. More...
 
label curTimeIndex_
 Current time index (used for updating) More...
 

Additional Inherited Members

- Public Types inherited from pointPatchField< vector >
typedef pointPatch Patch
 
- Public Types inherited from Field< vector >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Static Public Member Functions inherited from pointPatchField< vector >
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...
 
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 Member Functions inherited from Field< vector >
static const Field< Type > & null ()
 Return a null field. More...
 
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Attributes inherited from pointPatchField< vector >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. More...
 
- Static Public Attributes inherited from Field< vector >
static const char *const typeName
 

Detailed Description

Foam::sixDoFRigidBodyDisplacementPointPatchVectorField.

Source files

Definition at line 49 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ sixDoFRigidBodyDisplacementPointPatchVectorField() [1/4]

Construct from patch and internal field.

Definition at line 44 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

Referenced by sixDoFRigidBodyDisplacementPointPatchVectorField::clone().

Here is the caller graph for this function:

◆ sixDoFRigidBodyDisplacementPointPatchVectorField() [2/4]

Construct from patch, internal field and dictionary.

Definition at line 62 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

References dict, dictionary::found(), dictionary::lookup(), p, dictionary::readIfPresent(), and Foam::readScalar().

Here is the call graph for this function:

◆ sixDoFRigidBodyDisplacementPointPatchVectorField() [3/4]

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

Definition at line 104 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

◆ sixDoFRigidBodyDisplacementPointPatchVectorField() [4/4]

Construct as copy setting internal field reference.

Definition at line 124 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sixDoFRigidBodyDisplacement"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<vector> > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 123 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

References sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<pointPatchField<vector> > clone ( const DimensionedField< vector, pointMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValuePointPatchField< vector >.

Definition at line 143 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

References sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const pointPatchFieldMapper m)
virtual

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

Reimplemented from valuePointPatchField< vector >.

Definition at line 143 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

References valuePointPatchField< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap ( const pointPatchField< vector > &  ptf,
const labelList addr 
)
virtual

Reverse map the given pointPatchField onto this pointPatchField.

Reimplemented from valuePointPatchField< vector >.

Definition at line 154 of file sixDoFRigidBodyDisplacementPointPatchVectorField.C.

References sixDoFRigidBodyDisplacementPointPatchVectorField::initialPoints_, and valuePointPatchField< Type >::rmap().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

Field Documentation

◆ motion_

sixDoFRigidBodyMotion motion_
private

◆ initialPoints_

pointField initialPoints_
private

◆ rhoInf_

scalar rhoInf_
private

Reference density required by the forces object for.

incompressible calculations, required if rhoName == rhoInf

Definition at line 63 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

Referenced by sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::write().

◆ rhoName_

word rhoName_
private

Name of density field, optional unless used for an.

incompressible simulation, when this needs to be specified as rhoInf

Definition at line 68 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

Referenced by sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::write().

◆ lookupGravity_

label lookupGravity_
private

State of gravity lookup:

-1 = not determined yet, as the BC may be instantiated before g has been read into the db yet. Determination deferred until first call to updateCoeffs. A g keyword was not supplied to the dictionary. -2 = as for -1, but a gravity value was specified in the dictionary, specifying a value in the dictionary is considered a fatal error if g is available from the db. 0 = Use this boundary condition's own value of gravity, as not available from the db. 1 = Lookup gravity from db.

Definition at line 81 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

Referenced by sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::write().

◆ g_

vector g_
private

◆ curTimeIndex_

label curTimeIndex_
private

Current time index (used for updating)

Definition at line 87 of file sixDoFRigidBodyDisplacementPointPatchVectorField.H.

Referenced by sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().


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