SolVecSAFunc.cpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#include "pde/common/functions/SolVecSAFunc.hpp"
 
// =============================================================================
// SAFunc with data extracted from distributed vector
 
SolVecSAFunc::SolVecSAFunc(DHVecPtr* sol, CepsFunctionFlag location):
  SAFunc<CepsMathScalar>()
{
  setDataPointer(sol);  
  checkLocation(location);
}
 
void
SolVecSAFunc::setDataPointer(DHVecPtr* sol)
{
  CEPS_ABORT_IF(ceps::isNullPtr(sol) or ceps::isNullPtr(*sol),
    "Cannot initialize functor dependant on distributed vector, as passed ptr to vector is null"
  );
  m_sol = sol;
}
 
CepsEnum
SolVecSAFunc::getFlags() const
{
  return ceps::toIntegral(CepsFunctionFlag::Solution) | m_location;
}
 
CepsEnum
ceps::getFlagsOf(SolVecSAFunc* f)
{
  return f->getFlags();
}
 
void
SolVecSAFunc::getLocalData()
{
  m_sol->get()->getLocalData();
}
 
void
SolVecSAFunc::releaseLocalData()
{
  m_sol->get()->releaseLocalData();
}
 
void
SolVecSAFunc::checkLocation(const CepsFunctionFlag& location)
{
  CEPS_ABORT_IF(location != CepsFunctionFlag::CellIndex 
            and location != CepsFunctionFlag::NodeIndex
            and location != CepsFunctionFlag::DofIndex,
    "Cannot initialize a functor on distributed vector with a flag that is not DofIndex, CellIndex or NodeIndex"
  );
  m_location = location;
}
 
void
SolVecSAFunc::setArgsFromLocation(CepsStandardArgs& args) const
{
  args.u = 0.;
  if (m_location == CepsFunctionFlag::CellIndex)
    args.u = (**m_sol)[args.cellId];
  else if (m_location == CepsFunctionFlag::NodeIndex)
    args.u = (**m_sol)[args.nodeId];
  else
    args.u = (**m_sol)[args.dofId];
}