cell_zoneGenerator.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) 2026 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::zoneGenerators::cell
 
Description
    A zoneGenerator which converts the pointZones, faceZones and cellZones
    from a list of zoneGenerators into a single cellZone.
 
    For pointZones the cells containing any of the points are included.
    For faceZones the cells on either side of the faces are included.
    For cellZones the cells in the cellZones are included.
 
Usage
    \table
        Property     | Description             | Required | Default value
        type         | Type: cell              | yes      |
        name         | Name of the zone        | no       | zoneGenerator name
        cellType     | Cell type selection option | no    | master
        moveUpdate   | Switch to update after mesh motion | no | false
    \endtable
 
    Examples:
    Given a faceZone named \c plane is generated by
    \verbatim
        plane
        {
            type        plane;
            point       (0.5 0 0);
            normal      (1 0 0);
        }
    \endverbatim
    a cellZone named \c planeCells containing the cells from both sides of
    the \c plane faceZone is generated by
    \verbatim
        planeCells
        {
            type        cell;
 
            plane;      // lookup zone named 'plane'
        }
    \endverbatim
    or if the faceZone is not needed after the generation of the cellZone
    \verbatim
        planeCells
        {
            type        cell;
 
            plane
            {
                type        plane;
                point       (0.5 0 0);
                normal      (1 0 0);
            }
        }
    \endverbatim
    To create a cellZone from two zones named \c plane1 and \c plane2
    \verbatim
        planeCells
        {
            type        cell;
 
            plane1;     // lookup 'plane1'
            plane2;     // lookup 'plane2'
        }
    \endverbatim
 
SourceFiles
    cell_zoneGenerator.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef cell_zoneGenerator_H
#define cell_zoneGenerator_H
 
#include "zoneGeneratorList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace zoneGenerators
{
 
/*---------------------------------------------------------------------------*\
                              Class cell Declaration
\*---------------------------------------------------------------------------*/
 
class cell
:
    public zoneGenerator
{
    // Private Data
 
        //- List of zoneGenerators
        //  which generate the zones to convert to the cellZone
        zoneGeneratorList zoneGenerators_;
 
 
public:
 
    //- Runtime type information
    TypeName("cell");
 
 
    // Constructors
 
        //- Construct from dictionary
        cell
        (
            const word& name,
            const polyMesh& mesh,
            const dictionary& dict
        );
 
 
    //- Destructor
    virtual ~cell();
 
 
    // Member Functions
 
        virtual zoneSet generate() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace zoneGenerators
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //