Radial< Type > Class Template Reference

Function2 which returns a Function1 of the magnitude of the two-dimensional vector with components equal to the input arguments. More...

Inheritance diagram for Radial< Type >:
Collaboration diagram for Radial< Type >:

Public Member Functions

 TypeName ("radial")
 
 Radial (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Radial (const Radial< Type > &se)
 Copy constructor. More...
 
virtual ~Radial ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const
 Return value. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const Radial< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction2< Type, Radial< Type > >
 FieldFunction2 (const word &name)
 Construct from name. More...
 
virtual tmp< Function2< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction2 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x, const scalarField &y) const
 Return value as a function of two scalar fields. More...
 
- Public Member Functions inherited from Function2< Type >
 TypeName ("Function2")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f2)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
void operator= (const Function2< Type > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Function2< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function2< Type >
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function2s::Radial< Type >

Function2 which returns a Function1 of the magnitude of the two-dimensional vector with components equal to the input arguments.

Example

    <name>
    {
        type    radial;
        value   table
        (
            (0.00 (0 0 0))
            (0.35 (0 0 1))
            (0.71 (0 0 0))
        );
    }
Source files

Definition at line 67 of file Radial2.H.

Constructor & Destructor Documentation

◆ Radial() [1/2]

Radial ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 31 of file Radial2.C.

References Foam::units().

Here is the call graph for this function:

◆ Radial() [2/2]

Radial ( const Radial< Type > &  se)

Copy constructor.

Definition at line 47 of file Radial2.C.

◆ ~Radial()

~Radial
virtual

Destructor.

Definition at line 57 of file Radial2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "radial"  )

◆ value()

Type value ( const scalar  x,
const scalar  y 
) const
inlinevirtual

Return value.

Implements FieldFunction2< Type, Radial< Type > >.

Definition at line 32 of file Radial2I.H.

References Foam::mag(), x, and y.

Here is the call graph for this function:

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write data to dictionary stream.

Implements Function2< Type >.

Definition at line 64 of file Radial2.C.

References Foam::units(), and Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const Radial< Type > &  )
delete

Disallow default bitwise assignment.


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