Skip to content
Snippets Groups Projects
processorGAMGInterface.H 5.55 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*---------------------------------------------------------------------------*\
      =========                 |
      \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
       \\    /   O peration     |
    
    OpenFOAM bot's avatar
    OpenFOAM bot committed
        \\  /    A nd           | www.openfoam.com
    
         \\/     M anipulation  |
    
    -------------------------------------------------------------------------------
    
    OpenFOAM bot's avatar
    OpenFOAM bot committed
        Copyright (C) 2011-2014 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::processorGAMGInterface
    
    Description
        GAMG agglomerated processor interface.
    
    SourceFiles
        processorGAMGInterface.C
    
    \*---------------------------------------------------------------------------*/
    
    #ifndef processorGAMGInterface_H
    #define processorGAMGInterface_H
    
    #include "GAMGInterface.H"
    #include "processorLduInterface.H"
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    namespace Foam
    {
    
    /*---------------------------------------------------------------------------*\
                      Class processorGAMGInterface Declaration
    \*---------------------------------------------------------------------------*/
    
    class processorGAMGInterface
    :
        public GAMGInterface,
        public processorLduInterface
    {
        // Private data
    
    
            //- Communicator to use for parallel communication
            const label comm_;
    
    
            //- My processor rank in communicator
            label myProcNo_;
    
            //- Neighbouring processor rank in communicator
            label neighbProcNo_;
    
            //- Transformation tensor
            tensorField forwardT_;
    
            //- Message tag used for sending
            int tag_;
    
    
    
        // Private Member Functions
    
    
            //- No copy construct
            processorGAMGInterface(const processorGAMGInterface&) = delete;
    
            //- No copy assignment
            void operator=(const processorGAMGInterface&) = delete;
    
    
    
    public:
    
        //- Runtime type information
        TypeName("processor");
    
        // Constructors
    
            //- Construct from fine-level interface,
            //  local and neighbour restrict addressing
            processorGAMGInterface
            (
    
    mattijs's avatar
    mattijs committed
                const label index,
                const lduInterfacePtrsList& coarseInterfaces,
    
                const lduInterface& fineInterface,
                const labelField& restrictAddressing,
    
                const labelField& neighbourRestrictAddressing,
    
                const label fineLevelIndex,
                const label coarseComm
    
            //- Construct from components
            processorGAMGInterface
            (
                const label index,
                const lduInterfacePtrsList& coarseInterfaces,
                const labelUList& faceCells,
                const labelUList& faceRestrictAddresssing,
                const label coarseComm,
                const label myProcNo,
                const label neighbProcNo,
                const tensorField& forwardT,
                const int tag
            );
    
    
            //- Construct from Istream
            processorGAMGInterface
            (
                const label index,
                const lduInterfacePtrsList& coarseInterfaces,
                Istream& is
            );
    
    
        virtual ~processorGAMGInterface() = default;
    
    
    
        // Member Functions
    
            // Interface transfer functions
    
                //- Initialise neighbour field transfer
                virtual void initInternalFieldTransfer
                (
                    const Pstream::commsTypes commsType,
    
                ) const;
    
                //- Transfer and return internal field adjacent to the interface
                virtual tmp<labelField> internalFieldTransfer
                (
                    const Pstream::commsTypes commsType,
    
                ) const;
    
    
            //- Processor interface functions
    
    
                //- Return communicator used for sending
    
                virtual label comm() const
    
                {
                    return comm_;
                }
    
                //- Return processor number (rank in communicator)
    
                virtual int myProcNo() const
                {
    
    Andrew Heather's avatar
    Andrew Heather committed
                //- Return neighbour processor number (rank in communicator)
    
                virtual int neighbProcNo() const
                {
    
                }
    
                //- Return face transformation tensor
                virtual const tensorField& forwardT() const
                {
    
    mattijs's avatar
    mattijs committed
    
                //- Return message tag used for sending
                virtual int tag() const
                {
    
    
    
            // I/O
    
                //- Write to stream
                virtual void write(Ostream&) const;
    
    };
    
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    } // End namespace Foam
    
    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
    
    #endif
    
    // ************************************************************************* //