PDRobstacleTypes.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) 2019 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::PDRobstacles

Description
    Reader classes for concrete PDRsetFields obstacle types.

SourceFiles
    PDRobstacleTypes.C

\*---------------------------------------------------------------------------*/

#ifndef PDRobstacleTypes_H
#define PDRobstacleTypes_H

#include "PDRobstacle.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
namespace PDRobstacles
{

/*---------------------------------------------------------------------------*\
                          Class cylinder Declaration
\*---------------------------------------------------------------------------*/

struct cylinder : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::CYLINDER;
    static void read(PDRobstacle& obs, const dictionary& dict);
};



/*---------------------------------------------------------------------------*\
                          Class diagbeam Declaration
\*---------------------------------------------------------------------------*/

struct diagbeam : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::DIAG_BEAM;
    static void read(PDRobstacle& obs, const dictionary& dict);
};


/*---------------------------------------------------------------------------*\
                           Class cuboid Declaration
\*---------------------------------------------------------------------------*/

struct cuboid : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::CUBOID;
    static void read(PDRobstacle& obs, const dictionary& dict);
};



/*---------------------------------------------------------------------------*\
                           Class wallbeam Declaration
\*---------------------------------------------------------------------------*/

struct wallbeam : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::WALL_BEAM;
    static void read(PDRobstacle& obs, const dictionary& dict);
};


/*---------------------------------------------------------------------------*\
                           Class grating Declaration
\*---------------------------------------------------------------------------*/

struct grating : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::GRATING;
    static void read(PDRobstacle& obs, const dictionary& dict);
};


/*---------------------------------------------------------------------------*\
                           Class louver Declaration
\*---------------------------------------------------------------------------*/

struct louver : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::LOUVER_BLOWOFF;
    static void read(PDRobstacle& obs, const dictionary& dict);
};


/*---------------------------------------------------------------------------*\
                           Class patch Declaration
\*---------------------------------------------------------------------------*/

struct patch : public PDRobstacle
{
    static constexpr int enumTypeId = legacyTypes::RECT_PATCH;
    static void read(PDRobstacle& obs, const dictionary& dict);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace PDRobstacles
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //