newton_base.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//
//    FCST: Fuel Cell Simulation Toolbox
//
//    Copyright (C) 2009-13 by Energy Systems Design Laboratory, University of Alberta
//
//    This software is distributed under the MIT License.
//    For more information, see the README file in /doc/LICENSE
//
//    - Class: newton_base.h
//    - Description: Base class for all variants of the Newton-Raphson solver
//    - Developers: Jason Boisvert, M. Secanell, V. Zingan
//    - $Id: newton_base.h 2605 2014-08-15 03:36:44Z secanell $
//
//---------------------------------------------------------------------------

#ifndef __deal2__appframe__newton_base_h
#define __deal2__appframe__newton_base_h

#include <lac/solver_control.h>

#include "fe_vectors.h"
#include "application_data.h"
#include "event.h"
#include "application_base.h"
#include "application_wrapper.h"

using namespace dealii;
using namespace FuelCell::ApplicationCore;

namespace FuelCell
{
namespace ApplicationCore
{
    class newtonBase:public ApplicationWrapper
    {
    public:
        static const FuelCell::ApplicationCore::Event bad_derivative;
        newtonBase(ApplicationBase& app);

        virtual void declare_parameters (ParameterHandler& param);

        virtual void initialize (ParameterHandler& param);

        void _initialize (ParameterHandler& param);

        double threshold(double new_value);

        void initialize_initial_guess(BlockVector<double>& dst){};

        virtual void assemble();

        virtual double residual(FuelCell::ApplicationCore::FEVector& dst,
                                const FuelCell::ApplicationCore::FEVectors& rhs);

        virtual void solve(FuelCell::ApplicationCore::FEVector& u,
                           const FuelCell::ApplicationCore::FEVectors& in_vectors) = 0;

        ReductionControl control;

        double numIter;

    protected:
        void debug_output(const FEVector& sol,
                          const FEVector& update,
                          const FEVector& residual) const;

        bool assemble_now;

        double assemble_threshold;
        bool debug_solution;
        bool debug_update;
        bool debug_residual;
        unsigned int debug;
        unsigned int step;

        std::vector<unsigned int> blocks;

        unsigned int n_blocks;
    };
}
}

#endif