Public Member Functions | List of all members
uniform Class Reference

Uniform coordinate spacing. The i-th coordinate is given by: More...

Inheritance diagram for uniform:
Inheritance graph
[legend]
Collaboration diagram for uniform:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("uniform")
 Runtime type information. More...
 
 uniform (const word &name, const dimensionSet &dims, const label n, const dictionary &dict)
 Construct from a dictionary. More...
 
- Public Member Functions inherited from oneDimensionalDiscretisation
 TypeName ("oneDimensionalDiscretisation")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, oneDimensionalDiscretisation, dictionary,(const word &name, const dimensionSet &dims, const label n, const dictionary &dict),(name, dims, n, dict))
 
 oneDimensionalDiscretisation (const word &name, const dimensionSet &dims, const tmp< scalarField > &coordinates)
 Construct from components. More...
 
virtual ~oneDimensionalDiscretisation ()
 Destructor. More...
 
const scalarField & coordinates () const
 Return the coordinates. More...
 
PtrList< dimensionedScalar > dimensionedCoordinates () const
 Return the coordinates as a list of dimensioned scalars. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from oneDimensionalDiscretisation
static autoPtr< oneDimensionalDiscretisation > New (const word &name, const dimensionSet &dims, const label n, const dictionary &dict)
 Selector. More...
 

Detailed Description

Uniform coordinate spacing. The i-th coordinate is given by:

\[ x_i^q = x_{\textrm{min}}^q + \frac{i}{n - 1} \left( x_{\textrm{max}}^q - x_{\textrm{min}}^q \right) \]

Usage
Example specification: 
{
    type    uniform;

    // First and last coordinates
    min     0.01;
    max     0.51;

    // Optional moment/power of the coordinate to be spaced uniformly.
    // Defaults to one.
    q       1;
}
Source files

Definition at line 70 of file uniform_oneDimensionalDiscretisation.H.

Constructor & Destructor Documentation

◆ uniform()

uniform ( const word &  name,
const dimensionSet &  dims,
const label  n,
const dictionary &  dict 
)

Construct from a dictionary.

Definition at line 93 of file uniform_oneDimensionalDiscretisation.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniform"  )

Runtime type information.

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