preconditioners.h

Go to the documentation of this file.

//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //
//                                                                                   //
//                       / /   / /    __    \ \  / /                                 //
//                      / /__ / /   / _ \    \ \/ /                                  //
//                     /  ___  /   | |/_/    / /\ \                                  //
//                    / /   / /    \_\      / /  \ \                                 //
//                                                                                   //
//                                                                                   //
//  Copyright (c) 2016, Jakub Benda, Charles University in Prague                    //
//                                                                                   //
// MIT License:                                                                      //
//                                                                                   //
//  Permission is hereby granted, free of charge, to any person obtaining a          //
// copy of this software and associated documentation files (the "Software"),        //
// to deal in the Software without restriction, including without limitation         //
// the rights to use, copy, modify, merge, publish, distribute, sublicense,          //
// and/or sell copies of the Software, and to permit persons to whom the             //
// Software is furnished to do so, subject to the following conditions:              //
//                                                                                   //
//  The above copyright notice and this permission notice shall be included          //
// in all copies or substantial portions of the Software.                            //
//                                                                                   //
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS          //
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       //
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE       //
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, //
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF         //
// OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  //
//                                                                                   //
//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *  //

#ifndef HEX_ECS_PRECONDITIONERS
#define HEX_ECS_PRECONDITIONERS

// --------------------------------------------------------------------------------- //

#include <tuple>

// --------------------------------------------------------------------------------- //

#include "hex-arrays.h"
#include "hex-matrix.h"
#include "hex-rts.h"

// --------------------------------------------------------------------------------- //

#include "ang.h"
#include "radial.h"
#include "parallel.h"

// --------------------------------------------------------------------------------- //

class PreconditionerBase
{
    public:
        
        //
        // Run-time selection mechanism (object factory).
        //
        
            baseClassRunTimeSelectionDefinitions
            (
                PreconditionerBase,
                (
                    CommandLine  const & cmd,
                    InputFile    const & inp,
                    Parallel     const & par,
                    AngularBasis const & ang,
                    Bspline const & bspline_inner,
                    Bspline const & bspline_full,
                    Bspline const & bspline_panel_x,
                    Bspline const & bspline_panel_y
                )
            )
        
        //
        // Class member functions.
        //
        
            PreconditionerBase () : verbose_(true) {}
            
            virtual ~PreconditionerBase () {}
            
            virtual std::string description () const { return ""; }
            
            virtual void setup () {}
            
            virtual void update (Real E) {}
            
            virtual std::pair<int,int> bstates (Real E, int l1, int l2) const
            {
                return std::make_pair(0,0);
            }
            
            virtual void finish () {}
            
            virtual void rhs (BlockArray<Complex> & chi, int ie, int instate) const {}
            
            virtual void multiply
            (
                BlockArray<Complex> const & p,
                BlockArray<Complex> & q,
                MatrixSelection::Selection tri = MatrixSelection::BlockBoth | MatrixSelection::Both
            ) const {}
            
            virtual void precondition (BlockArray<Complex> const & r, BlockArray<Complex> & z) const {}
            
            virtual void verbose (bool b) { verbose_ = b; }
            
    protected:
        
        bool verbose_;
};

// --------------------------------------------------------------------------------- //

#define preconditionerRunTimeSelectionDefinitions(TYPE,NAME) \
    derivedClassRunTimeSelectionDefinitions \
    ( \
        PreconditionerBase, \
        ( \
            CommandLine  const & cmd, \
            InputFile    const & inp, \
            Parallel     const & par, \
            AngularBasis const & ang, \
            Bspline const & bspline_inner, \
            Bspline const & bspline_full,  \
            Bspline const & bspline_panel_x, \
            Bspline const & bspline_panel_y  \
        ), \
        TYPE, \
        ( \
            cmd, \
            inp, \
            par, \
            ang, \
            bspline_inner, \
            bspline_full,  \
            bspline_panel_x, \
            bspline_panel_y  \
        ), \
        NAME \
    )

// --------------------------------------------------------------------------------- //

#endif // HEX_ECS_PRECONDITIONERS