newton_argument.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
     ██╗████████╗██╗  ██╗ █████╗  ██████╗ █████╗       ███████╗██╗   ██╗
     ██║╚══██╔══╝██║  ██║██╔══██╗██╔════╝██╔══██╗      ██╔════╝██║   ██║
     ██║   ██║   ███████║███████║██║     ███████║█████╗█████╗  ██║   ██║
     ██║   ██║   ██╔══██║██╔══██║██║     ██╔══██║╚════╝██╔══╝  ╚██╗ ██╔╝
     ██║   ██║   ██║  ██║██║  ██║╚██████╗██║  ██║      ██║      ╚████╔╝
     ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝      ╚═╝       ╚═══╝
 
 * In real Time Highly Advanced Computational Applications for Finite Volumes
 * Copyright (C) 2017 by the ITHACA-FV authors
-------------------------------------------------------------------------------
License
    This file is part of ITHACA-FV
    ITHACA-FV is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    ITHACA-FV 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 Lesser General Public License for more details.
    You should have received a copy of the GNU Lesser General Public License
    along with ITHACA-FV. If not, see <http://www.gnu.org/licenses/>.
Class
    newton_argument
Description
    A general newton argument is implemented
SourceFiles
    newton_argument.H
\*---------------------------------------------------------------------------*/

 
 
#include <Eigen/Eigen>
 
#ifndef newton_argument_H
#define newton_argument_H

template<typename _Scalar, int NX = Eigen::Dynamic, int NY = Eigen::Dynamic>
class newton_argument
{
    public:
        typedef _Scalar Scalar;
        enum
        {
            InputsAtCompileTime = NX,
            ValuesAtCompileTime = NY
        };
        typedef Eigen::Matrix<Scalar, InputsAtCompileTime, 1> InputType;
        typedef Eigen::Matrix<Scalar, ValuesAtCompileTime, 1> ValueType;
        typedef Eigen::Matrix<Scalar, ValuesAtCompileTime, InputsAtCompileTime>
        JacobianType;
 
        int m_inputs, m_values;
 

        newton_argument() : m_inputs(InputsAtCompileTime),
            m_values(ValuesAtCompileTime) {}

        newton_argument(int inputs, int values) : m_inputs(inputs),
            m_values(values) {}

        int operator()(const Eigen::VectorXd& x, Eigen::VectorXd& fvec) const
        {
            Info <<
            "This is a virtual method, it needs to be overriden with a suitable residual function"
                      << endl;
            return 0;
        }

        int df(const Eigen::VectorXd& x, Eigen::VectorXd& fvec) const
        {
            Info <<
            "This is a virtual method, it needs to be overriden with a suitable jacobian function"
                      << endl;
            return 0;
        }

        int inputs() const
        {
            return m_inputs;
        }
 

        int values() const
        {
            return m_values;
        }
};
 
#endif