extrudeModel.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-2015 OpenFOAM Foundation
    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/>.
 
Class
    Foam::extrudeModel
 
Description
    Top level extrusion model class
 
    Dictionary entries
    \table
        Property       | Description                        | Required | Default
        nLayer         | Number of extrusion layers         | no  | 1
        expansionRatio | Expansion ratio                    | no  | 1
    \endtable
 
SourceFiles
    extrudeModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef extrudeModel_H
#define extrudeModel_H
 
#include "dictionary.H"
#include "point.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                        Class extrudeModel Declaration
\*---------------------------------------------------------------------------*/
 
class extrudeModel
{
protected:
 
    // Protected data
 
        label nLayers_;
 
        const scalar expansionRatio_;
 
        const dictionary& coeffDict_;
 
 
    // Private Member Functions
 
        //- No copy construct
        extrudeModel(const extrudeModel&) = delete;
 
        //- No copy assignment
        void operator=(const extrudeModel&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("extrudeModel");
 
    //- Declare runtime constructor selection table
 
        declareRunTimeSelectionTable
        (
            autoPtr,
            extrudeModel,
            dictionary,
            (
                const dictionary& dict
            ),
            (dict)
        );
 
 
    // Constructors
 
        //- Construct from dictionary for given model type
        //  The corresponding model Coeffs dictionary must exist.
        extrudeModel(const word& modelType, const dictionary& dict);
 
 
    // Selectors
 
        //- Select null constructed
        static autoPtr<extrudeModel> New(const dictionary& dict);
 
 
    //- Destructor
    virtual ~extrudeModel() = default;
 
 
    // Member Functions
 
        // Access
 
        //- Return the number of layers
        label nLayers() const;
 
        //- Return the expansion ratio
        scalar expansionRatio() const;
 
 
    // Member Operators
 
        //- Helper: calculate cumulative relative thickness for layer.
        //  (layer=0 -> 0; layer=nLayers -> 1)
        scalar sumThickness(const label layer) const;
 
        virtual point operator()
        (
            const point& surfacePoint,
            const vector& surfaceNormal,
            const label layer
        ) const = 0;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //