lineDivide.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-2016 OpenFOAM Foundation
    Copyright (C) 2020-2021 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::lineDivide
 
Description
    Divides a line into segments
 
SourceFiles
    lineDivide.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef lineDivide_H
#define lineDivide_H
 
#include "pointField.H"
#include "scalarList.H"
#include "gradingDescriptors.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
class blockEdge;
 
/*---------------------------------------------------------------------------*\
                         Class lineDivide Declaration
\*---------------------------------------------------------------------------*/
 
class lineDivide
{
    // Private Data
 
        pointField points_;
 
        scalarList divisions_;
 
public:
 
    // Constructors
 
        //- Construct from components
        lineDivide
        (
            const blockEdge& cedge,
            const label nDiv,
            const gradingDescriptors& gd = gradingDescriptors()
        );
 
 
    // Member Functions
 
        //- The points
        const pointField& points() const noexcept;
 
        //- The list of lambda values
        const scalarList& lambdaDivisions() const noexcept;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //