minor changes to interpolationTable

- use 'outOfBounds' dictionary keyword
 - avoid fileName expansion
 - removed unnecessary dictionary reference
This commit is contained in:
Mark Olesen
2008-07-07 12:51:16 +02:00
parent d7f85054e8
commit c8887472f8
2 changed files with 46 additions and 49 deletions

View File

@ -27,16 +27,16 @@ Class
Description
A list of times and values.
The time values must be positive and monotonically increasing.
The time values must be positive monotonically increasing.
The treatment of out-of-bounds values depends on the current setting
of bounding.
The handling of out-of-bounds values depends on the current setting
of @a outOfBounds.
If @a REPEAT bounding is in effect, the final time value is treated
as being equivalent to time=0 for the following periods.
If @a REPEAT is chosen for the out-of-bounds handling, the final time
value is treated as being equivalent to time=0 for the following periods.
Note
- Accessing an empty list will result in an error.
- Accessing an empty list results in an error.
- Accessing a list with a single element will always return the same value.
SourceFiles
@ -58,7 +58,7 @@ namespace Foam
class objectRegistry;
/*---------------------------------------------------------------------------*\
Class interpolationTable Declaration
Class interpolationTable Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
@ -71,7 +71,7 @@ public:
// Public data types
//- Enumeration for handling out-of-bound values
enum boundActions
enum boundsHandling
{
ERROR, /*!< Exit with a FatalError */
WARN, /*!< Issue warning and clamp value (default) */
@ -84,11 +84,8 @@ private:
// Private data
//- Parent dictionary
const dictionary& dict_;
//- Enumeration for handling out-of-bound values
boundActions boundAction_;
boundsHandling boundsHandling_;
//- File name
fileName fileName_;
@ -122,11 +119,11 @@ public:
return List<Tuple2<scalar, Type> >::size();
}
//- Return the out-of-bounds treatment as a word
word boundActionToWord(const boundActions& bound) const;
//- Return the out-of-bounds handling as a word
word boundsHandlingToWord(const boundsHandling& bound) const;
//- Return the out-of-bounds treatment as an enumeration
boundActions wordToBoundAction(const word& bound) const;
//- Return the out-of-bounds handling as an enumeration
boundsHandling wordToBoundsHandling(const word& bound) const;
// Check
@ -138,9 +135,9 @@ public:
// Edit
//- Set the out-of-bounds treatment from enum, return previous
// setting
boundActions boundAction(const boundActions& bound);
//- Set the out-of-bounds handling from enum,
// return previous setting
boundsHandling outOfBounds(const boundsHandling& bound);
// Member Operators