Handles the specification for grading within a section of a block. More...
Public Member Functions | |
gradingDescriptor () | |
Default construct (1, 1, 1) More... | |
gradingDescriptor (const scalar blockFraction, const scalar nDivFraction, const scalar expansionRatio) | |
Construct from components. More... | |
gradingDescriptor (const scalar expansionRatio) | |
Construct from expansionRatio. More... | |
gradingDescriptor (Istream &is) | |
Construct from Istream. More... | |
~gradingDescriptor ()=default | |
Destructor. More... | |
scalar | blockFraction () const |
scalar | nDivFraction () const |
scalar | expansionRatio () const |
void | correct () |
Adjust expansion ratio. More... | |
gradingDescriptor | inv () const |
Return the inverse gradingDescriptor with 1/expansionRatio. More... | |
bool | operator== (const gradingDescriptor &) const |
bool | operator!= (const gradingDescriptor &) const |
Friends | |
class | gradingDescriptors |
Istream & | operator>> (Istream &, gradingDescriptor &) |
Ostream & | operator<< (Ostream &, const gradingDescriptor &) |
Handles the specification for grading within a section of a block.
The grading specification is handled is controlled by three parameters:
Definition at line 66 of file gradingDescriptor.H.
Default construct (1, 1, 1)
Definition at line 28 of file gradingDescriptor.C.
gradingDescriptor | ( | const scalar | blockFraction, |
const scalar | nDivFraction, | ||
const scalar | expansionRatio | ||
) |
|
explicit |
Construct from expansionRatio.
Definition at line 52 of file gradingDescriptor.C.
References correct.
|
explicit |
Construct from Istream.
Definition at line 64 of file gradingDescriptor.C.
|
default |
Destructor.
|
inline |
Definition at line 117 of file gradingDescriptor.H.
|
inline |
Definition at line 122 of file gradingDescriptor.H.
|
inline |
Definition at line 127 of file gradingDescriptor.H.
void correct | ( | ) |
Adjust expansion ratio.
Trap negative value and treat as its inverse.
Definition at line 72 of file gradingDescriptor.C.
Referenced by gradingDescriptors::correct(), gradingDescriptors::normalise(), and Foam::operator>>().
Foam::gradingDescriptor inv | ( | ) | const |
Return the inverse gradingDescriptor with 1/expansionRatio.
Definition at line 81 of file gradingDescriptor.C.
bool operator== | ( | const gradingDescriptor & | gd | ) | const |
Definition at line 94 of file gradingDescriptor.C.
References Foam::equal().
bool operator!= | ( | const gradingDescriptor & | gd | ) | const |
Definition at line 103 of file gradingDescriptor.C.
References Foam::operator==().
|
friend |
Definition at line 78 of file gradingDescriptor.H.
|
friend |
|
friend |