tableBounds.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2017 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Namespace
    Foam::bounds
 
Description
    Namespace for bounding specifications.
    At the moment, mostly for tables.
 
SourceFiles
    tableBounds.cxx
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_tableBounds_H
#define Foam_tableBounds_H
 
#include "Enum.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace bounds
{
 
  // Enumerations
 
    //- Enumeration for handling out-of-bound values
    enum class normalBounding
    {
        ERROR,  
        WARN,   
        CLAMP   
    };
 
    //- Enumeration for handling out-of-bound values that are repeatable
    enum class repeatableBounding
    {
        ERROR,  
        WARN,   
        CLAMP,  
        REPEAT  
    };
 
 
    //- Strings corresponding to the normalBounding
    extern const Foam::Enum<normalBounding> normalBoundingNames;
 
    //- Strings corresponding to the repeatableBounding
    extern const Foam::Enum<repeatableBounding> repeatableBoundingNames;
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace bounds
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //