MapFieldConstraint< Type > Class Template Reference

The MapFieldConstraint constrains values of given fields of Type with a source field from an external mesh, where <Type>={scalar,vector,sphericalTensor,symmTensor,tensor}. Optionally, the source field can be translated and/or rotated as a function of time. More...

#include <MapFieldConstraint.H>

Inheritance diagram for MapFieldConstraint< Type >:

Collaboration diagram for MapFieldConstraint< Type >:

Public Member Functions
	TypeName ("MapFieldConstraint")
	Runtime type information.
	MapFieldConstraint (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	MapFieldConstraint (const MapFieldConstraint &)=delete
	No copy construct.
void	operator= (const MapFieldConstraint &)=delete
	No copy assignment.
virtual	~MapFieldConstraint ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read source dictionary.
virtual void	constrain (fvMatrix< Type > &eqn, const label)
	Set value on field.
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual bool	isActive ()
	Is the source active?
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)
virtual void	correct (volScalarField &field)
virtual void	correct (volVectorField &field)
virtual void	correct (volSphericalTensorField &field)
virtual void	correct (volSymmTensorField &field)
virtual void	correct (volTensorField &field)
virtual void	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &field)
virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Detailed Description

template<class Type>
class Foam::fv::MapFieldConstraint< Type >

The MapFieldConstraint constrains values of given fields of Type with a source field from an external mesh, where <Type>={scalar,vector,sphericalTensor,symmTensor,tensor}. Optionally, the source field can be translated and/or rotated as a function of time.

Usage

Minimal example by using constant/fvOptions:

\<Type\>MapFieldConstraint1
{
    // Mandatory entries
    type                \<Type\>MapFieldConstraint;
    field               <word>;
    srcMesh             <fileName>;
    mapMethod           <word>;

    // Optional entries
    consistent          <bool>;
    patchMapMethod      <word>;
    transform
    {
        // Optional entries
        position    <Function1<vector>>;
        origin      <vector>;

        direction   <Function1<vector>>;
        normal      <vector>;
    }

    // Conditional entries

        // when consistent=false
        patchMap        <HashTable<word>>;  // (<patchSrc> <patchTgt>);
        cuttingPatches  <wordList>;  // (<patchTgt1> ... <patchTgtN>);

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
type	Type name: <Type>MapFieldConstraint	word	yes	-
field	Name of operand field	word	yes	-
srcMesh	Directory path to mesh to map from	fileName	yes	-
mapMethod	Mapping method	word	yes	-
consistent	Flag to determine if meshes have consistent boundaries	bool	no	false
patchMapMethod	Name of patch-map method	word	no	-
patchMap	Coincident source/target patches in two cases	wordHashTable	no	-
cuttingPatches	Target patches cutting the source domain	wordList	no	-
transform	Transform settings for source mesh points	dict	no	-
position	Position of source mesh as a function of time	Function1<vector>	no	-
direction	Direction of source mesh as a function of time	Function1<vector>	no	-
origin	Origin of source mesh	vector	no	-
normal	Normal of reference plane representing source mesh	vector	no	-

The inherited entries are elaborated in:

• fvOption.H
• Function1.H

Source files

• MapFieldConstraint.H
• MapFieldConstraint.C

Definition at line 224 of file MapFieldConstraint.H.

Constructor & Destructor Documentation

MapFieldConstraint() [1/2]

template<class Type>

MapFieldConstraint	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh )

Construct from components.

Definition at line 202 of file MapFieldConstraint.C.

References dict, Foam::endl(), option::mesh(), option::mesh_, option::name(), option::option(), read(), Foam::returnReduceAnd(), and WarningInFunction.

Referenced by MapFieldConstraint(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

MapFieldConstraint() [2/2]

template<class Type>

MapFieldConstraint ( const MapFieldConstraint< Type > & )

delete

No copy construct.

References MapFieldConstraint().

Here is the call graph for this function:

~MapFieldConstraint()

template<class Type>

virtual ~MapFieldConstraint ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

TypeName()

template<class Type>

TypeName

(

"MapFieldConstraint< Type >"

)

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

operator=()

template<class Type>

void operator= ( const MapFieldConstraint< Type > & )

delete

No copy assignment.

References MapFieldConstraint().

Here is the call graph for this function:

read()

template<class Type>

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from option.

Definition at line 347 of file MapFieldConstraint.C.

References fileName::clean(), option::coeffs_, dict, Foam::exit(), string::expand(), Foam::FatalIOError, FatalIOErrorInFunction, option::fieldNames_, found, meshToMesh::interpolationMethodAMI(), meshToMesh::interpolationMethodNames_, name, Time::New(), Foam::nl, option::read(), option::resetApplied(), and Foam::type().

Referenced by MapFieldConstraint().

Here is the call graph for this function:

Here is the caller graph for this function:

constrain()

template<class Type>

void constrain ( fvMatrix< Type > & eqn, const label  )

virtual

Set value on field.

Definition at line 399 of file MapFieldConstraint.C.

References polyMesh::changing(), DebugInfo, Foam::endl(), option::fieldNames_, objectRegistry::lookupObjectRef(), option::mesh_, option::name_, and fvMatrix< Type >::setValues().

Here is the call graph for this function:

---

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

• src/fvOptions/constraints/general/mapFieldConstraint/MapFieldConstraint.H
• src/fvOptions/constraints/general/mapFieldConstraint/MapFieldConstraint.C