cell.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2022 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::cell
 
Description
    A cell is defined as a list of faces with extra functionality
 
SourceFiles
    cellI.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef cell_H
#define cell_H
 
#include "faceList.H"
#include "oppositeFace.H"
#include "boundBox.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
 
class cell;
bool operator==(const cell&, const cell&);
inline bool operator!=(const cell&, const cell&);
 
 
/*---------------------------------------------------------------------------*\
                            Class cell Declaration
\*---------------------------------------------------------------------------*/
 
class cell
:
    public labelList
{
 
public:
 
    // Static Data Members
 
        static const char* const typeName;
 
 
    // Constructors
 
        //- Construct null
        inline cell();
 
        //- Construct given size
        explicit inline cell(label);
 
        //- Construct from list of labels
        explicit inline cell(const labelUList&);
 
        //- Construct by transferring the parameter contents
        explicit inline cell(labelList&&);
 
        //- Construct from Istream
        inline cell(Istream&);
 
 
    // Member Functions
 
        //- Return number of faces
        inline label nFaces() const;
 
        //- Return labels of cell vertices
        labelList labels(const faceUList&) const;
 
        //- Return the cell vertices
        pointField points(const faceUList&, const pointField&) const;
 
        //- Return cell edges
        edgeList edges(const faceUList&) const;
 
        //- Return index of opposite face
        label opposingFaceLabel
        (
            const label masterFaceLabel,
            const faceUList& meshFaces
        ) const;
 
        //- Return opposite face oriented the same way as the master face
        oppositeFace opposingFace
        (
            const label masterFaceLabel,
            const faceUList& meshFaces
        ) const;
 
        // Instructions for centre and mag:
        // When one wants to access the cell centre and magnitude, the
        // functionality on the mesh level should be used in preference to the
        // functions provided here. They do not rely to the functionality
        // implemented here, provide additional checking and are more efficient.
        // The cell::centre and cell::mag functions may be removed in the
        // future.
 
        //- Returns cell centre
        point centre(const pointField&, const faceUList&) const;
 
        //- Returns cell volume
        scalar mag(const pointField&, const faceUList&) const;
 
        //- Returns the cell bounding box
        boundBox bb(const pointField&, const faceUList&) const;
 
 
    // Member Operators
 
        //- Move assignment labelList
        inline void operator=(labelList&&);
 
 
    // Friend Operators
 
        friend bool operator==(const cell&, const cell&);
        friend bool operator!=(const cell&, const cell&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "cellI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //