Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/utils/sparse_solvers/sparse_solver_base.hpp
235eaf0b5b35chloride

Last Change
Raw File

sparse_solver_base.hpp
View Options

/* =============================================================================
Copyright (c) 2014 - 2016
F. Georget <fabieng@princeton.edu> Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
============================================================================= */
#ifndef SPECMICP_SPARSESOLVERS_SPARSESOLVERSBASE_HPP
#define SPECMICP_SPARSESOLVERS_SPARSESOLVERSBASE_HPP
/*!
\file sparse_solvers/sparse_solver_base.hpp
\brief Interface of a sparse solver
*/
namespace specmicp {
namespace sparse_solvers {
enum class SparseSolverReturnCode;
//! \brief Abstract Base Class for a sparse solver
//!
//! \tparam MatrixT type of the matrix
//! \tparam DerivedR type of the residuals
//! \tparam DerivedS type of the solution
template <class MatrixT, class DerivedR, class DerivedS>
class SparseSolverBase
{
public:
virtual ~SparseSolverBase() {}
//! \brief Analyse the pattern of a matrix to speed up further decomposition
//!
//! May not have an effect in all sparse solver,
//! but have a non negligible effect on some
virtual void analyse_pattern(MatrixT& jacobian) = 0;
//! \brief Decompose the jacboian
virtual SparseSolverReturnCode decompose(MatrixT& jacobian) = 0;
//! \brief Solve the problem
virtual SparseSolverReturnCode solve(
const DerivedR& residuals,
DerivedS& solution
) = 0;
//! \brief Solve the problem with scaling factors for the residuals
virtual SparseSolverReturnCode solve_scaling(
const DerivedR& residuals,
const DerivedR& scaling,
DerivedS& solution
) = 0;
};
} // end namespace sparse_solvers
} // end namespace specmicp
#endif //SPECMICP_SPARSESOLVERS_SPARSESOLVERSBASE_HPP
c4science · Help