splitCell.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-2023 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::splitCell
 
Description
    Description of cell after splitting. Contains cellLabel and pointers
    to cells it split in. See directedRefinement.
 
SourceFiles
    splitCell.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef splitCell_H
#define splitCell_H
 
#include "label.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
 
/*---------------------------------------------------------------------------*\
                          Class splitCell Declaration
\*---------------------------------------------------------------------------*/
 
class splitCell
{
    // Private Data
 
        //- Unsplit cell label. Only uptodate if this cell is 'live'
        //  (i.e. no master or slave)
        label celli_;
 
        //- Parent splitCell or null
        splitCell* parent_;
 
        //- Cells replacing this or null
        splitCell* master_;
 
        splitCell* slave_;
 
 
public:
 
    // Constructors
 
        //- Construct from cell number and parent
        splitCell(const label celli, splitCell* parent);
 
        //- Disallow default bitwise copy construction
        splitCell(const splitCell&) = delete;
 
 
    //- Destructor
    ~splitCell();
 
 
    // Member Functions
 
        // Access
 
            label cellLabel() const
            {
                return celli_;
            }
 
            label& cellLabel()
            {
                return celli_;
            }
 
            splitCell* parent() const
            {
                return parent_;
            }
 
            splitCell*& parent()
            {
                return parent_;
            }
 
            splitCell* master() const
            {
                return master_;
            }
 
            splitCell*& master()
            {
                return master_;
            }
 
            splitCell* slave() const
            {
                return slave_;
            }
 
            splitCell*& slave()
            {
                return slave_;
            }
 
            //- Check if this is master cell of split
            bool isMaster() const;
 
            //- Check if this is unrefined (i.e. has no master or slave)
            bool isUnrefined() const;
 
            //- Returns other half of split cell. I.e. slave if this is master.
            splitCell* getOther() const;
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const splitCell&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //