manual.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2024 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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::decompositionMethods::manual
 
Description
    Decomposition given a cell-to-processor association in a file
 
SourceFiles
    manual.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef manual_H
#define manual_H
 
#include "decompositionMethod.H"
 
namespace Foam
{
namespace decompositionMethods
{
 
/*---------------------------------------------------------------------------*\
                        Class manual Declaration
\*---------------------------------------------------------------------------*/
 
class manual
:
    public decompositionMethod
{
    // Private Data
 
        fileName decompDataFile_;
 
 
public:
 
    //- Runtime type information
    TypeName("manual");
 
 
    // Constructors
 
        //- Construct given the decomposition dictionary
        manual(const dictionary& decompositionDict);
 
        //- Disallow default bitwise copy construction
        manual(const manual&) = delete;
 
 
    //- Destructor
    virtual ~manual()
    {}
 
 
    // Member Functions
 
        //- Return for every coordinate the wanted processor number. Use the
        //  mesh connectivity (if needed)
        virtual labelList decompose
        (
            const polyMesh& mesh,
            const pointField& cellCentres,
            const scalarField& cellWeights
        );
 
        //- Return for every coordinate the wanted processor number. Explicitly
        //  provided connectivity - does not use mesh_.
        //  The connectivity is equal to mesh.cellCells() except for
        //  - in parallel the cell numbers are global cell numbers (starting
        //    from 0 at processor0 and then incrementing all through the
        //    processors)
        //  - the connections are across coupled patches
        virtual labelList decompose
        (
            const labelListList& globalCellCells,
            const pointField& cellCentres,
            const scalarField& cellWeights
        )
        {
            NotImplemented;
            return labelList(0);
        }
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const manual&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace decompositionMethods
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //