zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: consolidate table bounding (issue #520)

Browse Source 
- replace duplicate code with global bounds enums and Enum
This commit is contained in:
Mark Olesen
2017-07-07 12:37:25 +02:00
parent 45dabbfe2b
commit 51d46079df
10 changed files with 258 additions and 402 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
src/OpenFOAM/primitives/functions/Function1/Table/TableBase.C
View File

@ -64,11 +64,13 @@ Foam::Function1Types::TableBase<Type>::TableBase
:
Function1<Type>(name),
name_(name),
boundsHandling_
bounding_
(
wordToBoundsHandling
bounds::repeatableBoundingNames.lookupOrFailsafe
(
dict.lookupOrDefault<word>("outOfBounds", "clamp")
"outOfBounds",
dict,
bounds::repeatableBounding::CLAMP
)
),
interpolationScheme_
@ -84,7 +86,7 @@ Foam::Function1Types::TableBase<Type>::TableBase(const TableBase<Type>& tbl)
:
Function1<Type>(tbl),
name_(tbl.name_),
boundsHandling_(tbl.boundsHandling_),
bounding_(tbl.bounding_),
interpolationScheme_(tbl.interpolationScheme_),
table_(tbl.table_),
tableSamplesPtr_(tbl.tableSamplesPtr_),
@ -101,90 +103,6 @@ Foam::Function1Types::TableBase<Type>::~TableBase()
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class Type>
Foam::word Foam::Function1Types::TableBase<Type>::boundsHandlingToWord
(
const boundsHandling& bound
) const
{
word enumName("warn");
switch (bound)
{
case ERROR:
{
enumName = "error";
break;
}
case WARN:
{
enumName = "warn";
break;
}
case CLAMP:
{
enumName = "clamp";
break;
}
case REPEAT:
{
enumName = "repeat";
break;
}
}
return enumName;
}
template<class Type>
typename Foam::Function1Types::TableBase<Type>::boundsHandling
Foam::Function1Types::TableBase<Type>::wordToBoundsHandling
(
const word& bound
) const
{
if (bound == "error")
{
return ERROR;
}
else if (bound == "warn")
{
return WARN;
}
else if (bound == "clamp")
{
return CLAMP;
}
else if (bound == "repeat")
{
return REPEAT;
}
else
{
WarningInFunction
<< "bad outOfBounds specifier " << bound << " using 'warn'"
<< endl;
return WARN;
}
}
template<class Type>
typename Foam::Function1Types::TableBase<Type>::boundsHandling
Foam::Function1Types::TableBase<Type>::outOfBounds
(
const boundsHandling& bound
)
{
boundsHandling prev = boundsHandling_;
boundsHandling_ = bound;
return prev;
}
template<class Type>
void Foam::Function1Types::TableBase<Type>::check() const
{
@ -223,33 +141,33 @@ bool Foam::Function1Types::TableBase<Type>::checkMinBounds
{
if (x < table_.first().first())
{
switch (boundsHandling_)
switch (bounding_)
{
case ERROR:
case bounds::repeatableBounding::ERROR:
{
FatalErrorInFunction
<< "value (" << x << ") underflow"
<< exit(FatalError);
break;
}
case WARN:
case bounds::repeatableBounding::WARN:
{
WarningInFunction
<< "value (" << x << ") underflow" << nl
<< endl;
// Behaviour as per 'CLAMP'
// Behaviour as per CLAMP
xDash = table_.first().first();
return true;
break;
}
case CLAMP:
case bounds::repeatableBounding::CLAMP:
{
xDash = table_.first().first();
return true;
break;
}
case REPEAT:
case bounds::repeatableBounding::REPEAT:
{
// adjust x to >= minX
const scalar span =
@ -282,33 +200,33 @@ bool Foam::Function1Types::TableBase<Type>::checkMaxBounds
{
if (x > table_.last().first())
{
switch (boundsHandling_)
switch (bounding_)
{
case ERROR:
case bounds::repeatableBounding::ERROR:
{
FatalErrorInFunction
<< "value (" << x << ") overflow"
<< exit(FatalError);
break;
}
case WARN:
case bounds::repeatableBounding::WARN:
{
WarningInFunction
<< "value (" << x << ") overflow" << nl
<< endl;
// Behaviour as per 'CLAMP'
// Behaviour as per CLAMP
xDash = table_.last().first();
return true;
break;
}
case CLAMP:
case bounds::repeatableBounding::CLAMP:
{
xDash = table_.last().first();
return true;
break;
}
case REPEAT:
case bounds::repeatableBounding::REPEAT:
{
// adjust x to >= minX
const scalar span =
@ -427,9 +345,13 @@ Foam::tmp<Foam::Field<Type>> Foam::Function1Types::TableBase<Type>::y() const
template<class Type>
void Foam::Function1Types::TableBase<Type>::writeEntries(Ostream& os) const
{
if (boundsHandling_ != CLAMP)
if (bounding_ != bounds::repeatableBounding::CLAMP)
{
os.writeEntry("outOfBounds", boundsHandlingToWord(boundsHandling_));
os.writeEntry
(
"outOfBounds",
bounds::repeatableBoundingNames[bounding_]
);
}
if (interpolationScheme_ != "linear")
{

34
src/OpenFOAM/primitives/functions/Function1/Table/TableBase.H
View File

@ -35,6 +35,7 @@ SourceFiles
#ifndef TableBase_H
#define TableBase_H
#include "tableBounds.H"
#include "Function1.H"
#include "Tuple2.H"
@ -57,20 +58,6 @@ class TableBase
:
public Function1<Type>
{
public:
// Public data types
//- Enumeration for handling out-of-bound values
enum boundsHandling
{
ERROR, //!< Exit with a FatalError
WARN, //!< Issue warning and clamp value (default)
CLAMP, //!< Clamp value to the start/end value
REPEAT //!< Treat as a repeating list
};
protected:
// Protected data
@ -78,8 +65,8 @@ protected:
//- Table name
const word name_;
//- Enumeration for handling out-of-bound values
const boundsHandling boundsHandling_;
//- Handling for out-of-bound values
const bounds::repeatableBounding bounding_;
//- Interpolation type
const word interpolationScheme_;
@ -108,7 +95,7 @@ protected:
private:
//- Disallow default bitwise assignment
void operator=(const TableBase<Type>&);
void operator=(const TableBase<Type>&) = delete;
public:
@ -128,15 +115,6 @@ public:
// Member Functions
//- Return the out-of-bounds handling as a word
word boundsHandlingToWord(const boundsHandling& bound) const;
//- Return the out-of-bounds handling as an enumeration
boundsHandling wordToBoundsHandling(const word& bound) const;
//- Set the out-of-bounds handling from enum, return previous setting
boundsHandling outOfBounds(const boundsHandling& bound);
//- Check the table for size and consistency
void check() const;
@ -164,8 +142,8 @@ public:
//- Write all table data in dictionary format
virtual void writeData(Ostream& os) const;
//- Write keywords only in dictionary format. Used for non-inline
// table types
//- Write keywords only in dictionary format.
// Used for non-inline table types
virtual void writeEntries(Ostream& os) const;
};