Loading...
Searching...
No Matches
coordinateScaling< Type > Class Template Reference

Helper class to wrap coordinate system and component-wise scaling. More...

#include <coordinateScaling.H>

Inheritance diagram for coordinateScaling< Type >:
Inheritance graph
[legend]

Public Member Functions

 coordinateScaling ()
 Default construct.
 coordinateScaling (const objectRegistry &obr, const dictionary &dict)
 Construct from registry and dictionary.
 coordinateScaling (const coordinateScaling &rhs)
 Construct copy.
virtual ~coordinateScaling ()=default
 Destructor.
bool active () const noexcept
 Has any scaling or coordinate transformation.
const autoPtr< coordinateSystem > & coordSys () const
 Access to optional coordinate system.
tmp< pointField > localPosition (const pointField &globalPos) const
 Convert to local coordinates, pass-through if no coordinate system is active.
virtual tmp< Field< Type > > transform (const pointField &pos, const Field< Type > &local) const
 Evaluate.
virtual void writeEntry (Ostream &os) const
 Write dictionary entry.
tmp< Field< label > > transform (const pointField &pos, const Field< label > &local) const
Foam::tmp< Foam::Field< Foam::label > > transform (const pointField &pos, const Field< label > &local) const

Detailed Description

template<class Type>
class Foam::coordinateScaling< Type >

Helper class to wrap coordinate system and component-wise scaling.

See also
Foam::Function1Types
Source files

Definition at line 51 of file coordinateScaling.H.

Constructor & Destructor Documentation

◆ coordinateScaling() [1/3]

template<class Type>
coordinateScaling ( )

Default construct.

Definition at line 24 of file coordinateScaling.C.

Referenced by coordinateScaling().

Here is the caller graph for this function:

◆ coordinateScaling() [2/3]

template<class Type>
coordinateScaling ( const objectRegistry & obr,
const dictionary & dict )

Construct from registry and dictionary.

Definition at line 33 of file coordinateScaling.C.

References dict, Foam::name(), VectorSpace< Form, Cmpt, Ncmpts >::nComponents, and Function1< Type >::NewIfPresent().

Here is the call graph for this function:

◆ coordinateScaling() [3/3]

template<class Type>
coordinateScaling ( const coordinateScaling< Type > & rhs)

Construct copy.

Definition at line 59 of file coordinateScaling.C.

References coordinateScaling(), and Foam::rhs().

Here is the call graph for this function:

◆ ~coordinateScaling()

template<class Type>
virtual ~coordinateScaling ( )
virtualdefault

Destructor.

Member Function Documentation

◆ active()

template<class Type>
bool active ( ) const
inlinenoexcept

Has any scaling or coordinate transformation.

Definition at line 113 of file coordinateScaling.H.

References Foam::noexcept.

◆ coordSys()

template<class Type>
const autoPtr< coordinateSystem > & coordSys ( ) const
inline

Access to optional coordinate system.

Definition at line 121 of file coordinateScaling.H.

◆ localPosition()

template<class Type>
Foam::tmp< Foam::pointField > localPosition ( const pointField & globalPos) const

Convert to local coordinates, pass-through if no coordinate system is active.

Definition at line 70 of file coordinateScaling.C.

◆ transform() [1/3]

template<class Type>
Foam::tmp< Foam::Field< Type > > transform ( const pointField & pos,
const Field< Type > & local ) const
virtual

Evaluate.

Definition at line 85 of file coordinateScaling.C.

◆ writeEntry()

template<class Type>
void writeEntry ( Ostream & os) const
virtual

Write dictionary entry.

Definition at line 131 of file coordinateScaling.C.

References forAll, and os().

Here is the call graph for this function:

◆ transform() [2/3]

tmp< Field< label > > transform ( const pointField & pos,
const Field< label > & local ) const

◆ transform() [3/3]

Foam::tmp< Foam::Field< Foam::label > > transform ( const pointField & pos,
const Field< label > & local ) const

Definition at line 27 of file coordinateScalings.C.

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