oppositeFace.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) 2011 OpenFOAM Foundation
-------------------------------------------------------------------------------
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/>.
 
Class
    Foam::oppositeFace
 
Description
    Class containing opposite face for a prismatic cell with addressing
    and a possibility of failure.
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_oppositeFace_H
#define Foam_oppositeFace_H
 
#include "face.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class oppositeFace Declaration
\*---------------------------------------------------------------------------*/
 
class oppositeFace
:
    public face
{
    // Private Data
 
        //- Master face index
        const label masterIndex_;
 
        //- Opposite face index
        const label oppositeIndex_;
 
 
public:
 
    // Constructors
 
        //- Construct from components
        oppositeFace
        (
            const face& f,
            const label masterIndex,
            const label oppositeIndex
        )
        :
            face(f),
            masterIndex_(masterIndex),
            oppositeIndex_(oppositeIndex)
 
        {}
 
 
    // Member Functions
 
        //- Master face index
        label masterIndex() const noexcept
        {
            return masterIndex_;
        }
 
        //- Opposite face index
        label oppositeIndex() const noexcept
        {
            return oppositeIndex_;
        }
 
        //- Does the opposite face exist?
        bool good() const noexcept
        {
            return oppositeIndex_ >= 0;
        }
 
        //- Does the opposite face exist?
        bool found() const noexcept { return good(); }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //