Matrice_Base.cpp

/****************************************************************************
* Copyright (c) 2026, CEA
* 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.
*
*****************************************************************************/
 
#include <Matrice_Base.h>
#include <Matrice_Morse.h>
#include <Matrice_Morse_Sym.h>
#include <Matrix_tools.h>
#include <Array_tools.h>
 
Implemente_base(Matrice_Base,"Matrice_Base",Objet_U);
 
Sortie& Matrice_Base::
printOn(Sortie& s ) const
{
  return s << que_suis_je() << finl;
}
Entree& Matrice_Base::
readOn(Entree& s )
{
  return s ;
}
 
/*! @brief Friend function (outside the class) of the Matrice_Base class.
 *
 * Multiplication operator: returns (A*vect)
 *     Calls Matrice_base::multv(const DoubleVect&) on A.
 *
 * @param (Matrice_Base& A) the multiplying matrix
 * @param (DoubleVect& vect) the vector to multiply
 * @return (DoubleVect) the result vector of the operation
 */
DoubleVect operator * (const Matrice_Base& A, const DoubleVect& vect)
{
  DoubleVect r(A.nb_colonnes());
  return A.multvect(vect, r);
}
 
void Matrice_Base::build_stencil()
{
  Cerr << "Error in 'Matrice_Base::build_stencil( )"<<finl;
  Cerr << "  This method should be implemented in derived class." << finl;
  Cerr << "  Exiting..." << finl;
  Process::exit( );
}
 
int Matrice_Base::get_stencil_size() const
{
  return stencil_.dimension( 0 );
}
 
void Matrice_Base::get_stencil( Stencil& stencil ) const
{
  Cerr << "Error in 'Matrice_Base::get_stencil( )':" << finl;
  Cerr << "  This method should be implemented in derived class." << finl;
  Cerr << "  Exiting..." << finl;
  Process::exit( );
}
 
void Matrice_Base::get_symmetric_stencil( Stencil& stencil ) const
{
  Matrice_Morse tmp1;
  Matrix_tools::convert_to_morse_matrix( *this, tmp1 );
 
  Matrice_Morse_Sym tmp2( tmp1 );
  tmp2.get_symmetric_stencil( stencil );
}
 
void Matrice_Base::get_stencil_and_coefficients( Stencil&       stencil,
                                                 StencilCoeffs& coefficients ) const
{
  Cerr << "Error in 'Matrice_Base::get_stencill_and_coefficients( )':" << finl;
  Cerr << "  This method should be implemented in derived class" << finl;
  Cerr << "  Exiting..." << finl;
  Process::exit( );
}
 
void Matrice_Base::get_stencil_and_coeff_ptrs(Stencil& stencil, std::vector<const double *>& coeff_ptr) const
{
  Cerr << "Error in 'Matrice_Base::get_stencil_and_coeff_ptrs( )':" << finl;
  Cerr << "  This method should be implemented in derived class" << finl;
  Cerr << "  Exiting..." << finl;
  Process::exit( );
}
 
 
void Matrice_Base::get_symmetric_stencil_and_coefficients( Stencil&       stencil,
                                                           StencilCoeffs& coefficients ) const
{
  Matrice_Morse tmp1;
  Matrix_tools::convert_to_morse_matrix( *this, tmp1 );
 
  Matrice_Morse_Sym tmp2( tmp1 );
  tmp2.get_symmetric_stencil_and_coefficients( stencil, coefficients );
}
 
void Matrice_Base::set_stencil( const Stencil& stencil )
{
  stencil_ = stencil ;
  tableau_trier_retirer_doublons( stencil_ );
  is_stencil_up_to_date_ = false ;
}
 
bool Matrice_Base::is_stencil_up_to_date() const
{
  return is_stencil_up_to_date_;
}