Homec4science
Diffusion LibMultiScale (features/pybind) Browse

libmultiscale/src/math/matrix.hh
b05d5f2aba78features/pybind

Last Change
Raw File

matrix.hh
View Options

/**
* @file matrix.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
*
* @date Fri Jul 11 15:47:44 2014
*
* @brief This is a wrapper to a matrix type to be used when algebra is needed
*
* @section LICENSE
*
* Copyright INRIA and CEA
*
* The LibMultiScale is a C++ parallel framework for the multiscale
* coupling methods dedicated to material simulations. This framework
* provides an API which makes it possible to program coupled simulations
* and integration of already existing codes.
*
* This Project was initiated in a collaboration between INRIA Futurs Bordeaux
* within ScAlApplix team and CEA/DPTA Ile de France.
* The project is now continued at the Ecole Polytechnique Fédérale de Lausanne
* within the LSMS/ENAC laboratory.
*
* This software is governed by the CeCILL-C license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL-C
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL-C license and that you accept its terms.
*
*/
#ifndef __LIBMULTISCALE_MATRIX_HH__
#define __LIBMULTISCALE_MATRIX_HH__
/* -------------------------------------------------------------------------- */
#include <stdio.h>
#include "array.hh"
#include <fstream>
#include <iostream>
/* -------------------------------------------------------------------------- */
__BEGIN_LIBMULTISCALE__
namespace math {
class MatrixBase {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
MatrixBase(UInt m,UInt n){_m = m;_n = n;};
virtual ~MatrixBase(){};
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
//! access to the coordinate i,j
virtual Real& at(UInt i, UInt j) = 0;
//! access to the coordinate i,j
virtual Real& operator()(UInt i, UInt j) = 0;
//! perform LU facotrization
virtual void factoLU() = 0;
//! solve the system Ax=b where b is the rhs parameter and A is current class.
virtual void solve(Array * rhs) = 0;
//! print to screen the matrix
void print(){
this->printToFile(std::cout);
};
//! print to a given file(by filename) the matrix
void printToFile(char * f){
std::ofstream file(f);
printToFile(file);
};
//! print to file by opened FILE pointer
void printToFile(std::ostream & file){
for (UInt i=0;i< _m;++i)
for (UInt j=0;j< _n;++j){
if (this->at(i,j) != 0)
file << i+1 << "\t" << j+1 << "\t" << this->at(i,j) << std::endl;
}
};
//! return m dimention of the matrix
UInt m(){
return _m;
}
//!return n dimention of the matrix
UInt n(){
return _n;
}
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
//! dimensions of the matrix
UInt _m,_n;
//! pivot used to perform facto LU
std::vector<int> pivot;
};
}
__END_LIBMULTISCALE__
#endif /* __LIBMULTISCALE_MATRIX_HH__ */
c4science · Help