surfaceCellSizeFunction.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) 2012-2015 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::surfaceCellSizeFunction
 
Description
    Abstract base class for specifying target cell sizes
 
SourceFiles
    surfaceCellSizeFunction.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef surfaceCellSizeFunction_H
#define surfaceCellSizeFunction_H
 
#include "searchableSurface.H"
#include "dictionary.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class surfaceCellSizeFunction Declaration
\*---------------------------------------------------------------------------*/
 
class surfaceCellSizeFunction
:
    public dictionary
{
 
protected:
 
    // Protected data
 
        //- Reference to the searchableSurface that surfaceCellSizeFunction
        //  relates to
        const searchableSurface& surface_;
 
        const dictionary coeffsDict_;
 
        const scalar& defaultCellSize_;
 
        //- If cell resizing is allowed, this is the factor of the old cell size
        //  to get the new cell size
        scalar refinementFactor_;
 
 
private:
 
    // Private Member Functions
 
        //- No copy construct
        surfaceCellSizeFunction(const surfaceCellSizeFunction&) = delete;
 
        //- No copy assignment
        void operator=(const surfaceCellSizeFunction&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("surfaceCellSizeFunction");
 
 
    // Declare run-time constructor selection table
 
        declareRunTimeSelectionTable
        (
            autoPtr,
            surfaceCellSizeFunction,
            dictionary,
            (
                const dictionary& surfaceCellSizeFunctionDict,
                const searchableSurface& surface,
                const scalar& defaultCellSize
            ),
            (surfaceCellSizeFunctionDict, surface, defaultCellSize)
        );
 
 
    // Constructors
 
        //- Construct from components
        surfaceCellSizeFunction
        (
            const word& type,
            const dictionary& surfaceCellSizeFunctionDict,
            const searchableSurface& surface,
            const scalar& defaultCellSize
        );
 
 
    // Selectors
 
        //- Return a reference to the selected surfaceCellSizeFunction
        static autoPtr<surfaceCellSizeFunction> New
        (
            const dictionary& surfaceCellSizeFunctionDict,
            const searchableSurface& surface,
            const scalar& defaultCellSize
        );
 
 
    //- Destructor
    virtual ~surfaceCellSizeFunction() = default;
 
 
    // Member Functions
 
        //- Const access to the details dictionary
        inline const dictionary& coeffsDict() const
        {
            return coeffsDict_;
        }
 
        virtual scalar interpolate
        (
            const point& pt,
            const label index
        ) const = 0;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //