cellSizeAndAlignmentControls.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::cellSizeAndAlignmentControls
 
Description
 
SourceFiles
    cellSizeAndAlignmentControls.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef cellSizeAndAlignmentControls_H
#define cellSizeAndAlignmentControls_H
 
#include "dictionary.H"
#include "cellSizeAndAlignmentControl.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class cellSizeAndAlignmentControls Declaration
\*---------------------------------------------------------------------------*/
 
class cellSizeAndAlignmentControls
{
    // Private data
 
        const dictionary& shapeControlDict_;
 
        const conformationSurfaces& geometryToConformTo_;
 
        PtrList<cellSizeAndAlignmentControl> controlFunctions_;
 
        const scalar defaultCellSize_;
 
 
    // Private Member Functions
 
        bool evalCellSizeFunctions
        (
            const point& pt,
            scalar& minSize,
            label& maxPriority
        ) const;
 
        //- No copy construct
        cellSizeAndAlignmentControls
        (
            const cellSizeAndAlignmentControls&
        ) = delete;
 
        //- No copy assignment
        void operator=(const cellSizeAndAlignmentControls&) = delete;
 
 
public:
 
        //- Runtime type information
        ClassName("cellSizeAndAlignmentControls");
 
 
    // Constructors
 
        //- Construct from dictionary
        cellSizeAndAlignmentControls
        (
            const Time& runTime,
            const dictionary& shapeControlDict,
            const conformationSurfaces& geometryToConformTo,
            const scalar& defaultCellSize
        );
 
 
    //- Destructor
    virtual ~cellSizeAndAlignmentControls();
 
 
    // Member Functions
 
        // Access
 
            inline const PtrList<cellSizeAndAlignmentControl>&
            controlFunctions() const
            {
                return controlFunctions_;
            }
 
            inline const conformationSurfaces& geometryToConformTo() const
            {
                return geometryToConformTo_;
            }
 
 
        // Query
 
            scalar cellSize(const point& pt) const;
 
            scalar cellSize(const point& pt, label& maxPriority) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //