coordinateScaling< Type > Class Template Reference

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

Inheritance diagram for coordinateScaling< Type >:
[legend]

Public Member Functions

 coordinateScaling ()
 Default construct. More...
 
 coordinateScaling (const objectRegistry &obr, const dictionary &dict)
 Construct from registry and dictionary. More...
 
 coordinateScaling (const coordinateScaling &rhs)
 Construct copy. More...
 
virtual ~coordinateScaling ()=default
 Destructor. More...
 
bool active () const
 Has any scaling or coordinate transformation. More...
 
const autoPtr< coordinateSystem > & coordSys () const
 Access to optional coordinate system. More...
 
virtual tmp< Field< Type > > transform (const pointField &pos, const Field< Type > &local) const
 Evaluate. More...
 
virtual void writeEntry (Ostream &os) const
 Write dictionary entry. More...
 
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 55 of file coordinateScaling.H.

Constructor & Destructor Documentation

◆ coordinateScaling() [1/3]

Default construct.

Definition at line 31 of file coordinateScaling.C.

◆ coordinateScaling() [2/3]

coordinateScaling ( const objectRegistry obr,
const dictionary dict 
)

Construct from registry and dictionary.

Definition at line 40 of file coordinateScaling.C.

References dict, dictionary::found(), Foam::name(), and pTraits< bool >::nComponents.

Here is the call graph for this function:

◆ coordinateScaling() [3/3]

coordinateScaling ( const coordinateScaling< Type > &  rhs)

Construct copy.

Definition at line 69 of file coordinateScaling.C.

◆ ~coordinateScaling()

virtual ~coordinateScaling ( )
virtualdefault

Destructor.

Member Function Documentation

◆ active()

bool active ( ) const
inline

Has any scaling or coordinate transformation.

Definition at line 99 of file coordinateScaling.H.

◆ coordSys()

const autoPtr< coordinateSystem > & coordSys ( ) const
inline

Access to optional coordinate system.

Definition at line 105 of file coordinateScaling.H.

◆ transform() [1/3]

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

Evaluate.

Definition at line 80 of file coordinateScaling.C.

◆ writeEntry()

void writeEntry ( Ostream os) const
virtual

Write dictionary entry.

Definition at line 126 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 34 of file coordinateScalings.C.


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