uniformInterpolatedDisplacementPointPatchVectorField Class Reference

Interpolates pre-specified motion. More...

Inheritance diagram for uniformInterpolatedDisplacementPointPatchVectorField:

Collaboration diagram for uniformInterpolatedDisplacementPointPatchVectorField:

Public Member Functions
	TypeName ("uniformInterpolatedDisplacement")
	Runtime type information. More...
	uniformInterpolatedDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
	Construct from patch and internal field. More...
	uniformInterpolatedDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	uniformInterpolatedDisplacementPointPatchVectorField (const uniformInterpolatedDisplacementPointPatchVectorField &, 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...
	uniformInterpolatedDisplacementPointPatchVectorField (const uniformInterpolatedDisplacementPointPatchVectorField &, 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	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	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. 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 objectRegistry &	db () const
	Return local objectRegistry. More...
label	size () const
	Return size. More...
const pointPatch &	patch () 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 word &	patchType () const
	Optional patch type. More...
word &	patchType ()
	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 word &	constraintType () 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
const word	fieldName_
	Name of displacement field. More...
const word	interpolationScheme_
wordList	timeNames_
	Times with pre-specified displacement. More...
scalarField	timeVals_
	Times with pre-specified displacement. More...
autoPtr< interpolationWeights >	interpolatorPtr_
	User-specified interpolator. More...
labelList	currentIndices_
	Cached interpolation times. More...
scalarField	currentWeights_
	Cached interpolation weights. 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 word &	calculatedType ()
	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

Interpolates pre-specified motion.

Motion specified as pointVectorFields. E.g.

walls { type uniformInterpolatedDisplacement; value uniform (0 0 0); fieldName wantedDisplacement; interpolationScheme linear; }

This will scan the case for 'wantedDisplacement' pointVectorFields and interpolate those in time (using 'linear' interpolation) to obtain the current displacement. The advantage of specifying displacement in this way is that it automatically works through decomposePar.

Source files

• uniformInterpolatedDisplacementPointPatchVectorField.H
• uniformInterpolatedDisplacementPointPatchVectorField.C

Definition at line 66 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

uniformInterpolatedDisplacementPointPatchVectorField() [1/4]

uniformInterpolatedDisplacementPointPatchVectorField	(	const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 44 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::clone().

Here is the caller graph for this function:

uniformInterpolatedDisplacementPointPatchVectorField() [2/4]

uniformInterpolatedDisplacementPointPatchVectorField	(	const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 55 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

References DynamicList::append(), dict, dimensionedInternalField(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Time::findTimes(), forAll, dictionary::found(), IOobject::headerOk(), Foam::Info, IOobject::MUST_READ, Foam::name(), IOobject::NO_WRITE, path(), List::size(), and Foam::type().

Here is the call graph for this function:

uniformInterpolatedDisplacementPointPatchVectorField() [3/4]

uniformInterpolatedDisplacementPointPatchVectorField	(	const uniformInterpolatedDisplacementPointPatchVectorField &	ptf,
		const pointPatch &	p,
		const DimensionedField< vector, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper
	)

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

Definition at line 114 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

uniformInterpolatedDisplacementPointPatchVectorField() [4/4]

uniformInterpolatedDisplacementPointPatchVectorField	(	const uniformInterpolatedDisplacementPointPatchVectorField &	ptf,
		const DimensionedField< vector, pointMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 132 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

Member Function Documentation

TypeName()

TypeName

(

"uniformInterpolatedDisplacement"

)

Runtime type information.

clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 126 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

References uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField().

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 146 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

References uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField().

Here is the call graph for this function:

updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from valuePointPatchField< vector >.

Definition at line 148 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

References IOobject::AUTO_WRITE, GeometricField::correctBoundaryConditions(), uniformInterpolatedDisplacementPointPatchVectorField::currentIndices_, uniformInterpolatedDisplacementPointPatchVectorField::currentWeights_, pointPatchField< vector >::dimensionedInternalField(), GeometricField::dimensionedInternalField(), uniformInterpolatedDisplacementPointPatchVectorField::fieldName_, forAllConstIter(), HashTable< nil, word, string::hash >::found(), uniformInterpolatedDisplacementPointPatchVectorField::interpolationScheme_, uniformInterpolatedDisplacementPointPatchVectorField::interpolatorPtr_, objectRegistry::lookupObject(), Foam::name(), interpolationWeights::New(), IOobject::NO_READ, pointPatchField< vector >::patchInternalField(), objectRegistry::subRegistry(), pointMesh::thisDb(), IOobject::time(), Time::timeName(), uniformInterpolatedDisplacementPointPatchVectorField::timeNames_, TimeState::timeOutputValue(), uniformInterpolatedDisplacementPointPatchVectorField::timeVals_, HashTable::toc(), valuePointPatchField< Type >::updateCoeffs(), and pointPatchField< vector >::updated().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write.

Reimplemented from valuePointPatchField< vector >.

Definition at line 259 of file uniformInterpolatedDisplacementPointPatchVectorField.C.

References token::END_STATEMENT, uniformInterpolatedDisplacementPointPatchVectorField::fieldName_, uniformInterpolatedDisplacementPointPatchVectorField::interpolationScheme_, Foam::nl, pointPatchField::write(), Field< vector >::writeEntry(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

fieldName_

const word fieldName_

private

Name of displacement field.

Definition at line 73 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

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

interpolationScheme_

const word interpolationScheme_

private

Definition at line 75 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

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

timeNames_

wordList timeNames_

private

Times with pre-specified displacement.

Definition at line 78 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

timeVals_

scalarField timeVals_

private

Times with pre-specified displacement.

Definition at line 81 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

interpolatorPtr_

autoPtr<interpolationWeights> interpolatorPtr_

private

User-specified interpolator.

Definition at line 84 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

currentIndices_

labelList currentIndices_

private

Cached interpolation times.

Definition at line 88 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

currentWeights_

scalarField currentWeights_

private

Cached interpolation weights.

Definition at line 91 of file uniformInterpolatedDisplacementPointPatchVectorField.H.

Referenced by uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

---

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

• src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H
• src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.C