BoundaryCondition.tpp

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
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
/** @file BoundaryCondition.cpp Wrapper around Field, specialized with parameters for BCs*/
// #included from  "pde/common/functions/BoundaryCondition.hpp"
 
template <class _Result>
BoundaryCondition<_Result>::BoundaryCondition(
  ScalarSAFunc*                       functor,
  const CepsVector<DegreeOfFreedom*>* domain,
  CepsUnknownIndex                    unknown
) :
  Field<_Result,DegreeOfFreedom>(functor,domain),
  m_type   (CepsBoundaryConditionFlag::Dirichlet),
  m_alpha  (nullptr),
  m_beta   (nullptr),
  m_unknown(unknown)
{
}
 
template <class _Result>
BoundaryCondition<_Result>::~BoundaryCondition()
{
}
 
template <class _Result>
void
BoundaryCondition<_Result>::setBoundaryConditionType(CepsBoundaryConditionFlag type)
{
  m_type = type;
  return;
}
 
template <class _Result>
CepsBoundaryConditionFlag
BoundaryCondition<_Result>::getBoundaryConditionType() const
{
  return m_type;
}
 
template <class _Result>
CepsUnknownIndex
BoundaryCondition<_Result>::getUnknownId() const
{
  return m_unknown;
}
 
 
template <class _Result>
void
BoundaryCondition<_Result>::setAlpha(CoeffFunc alpha)
{
  m_alpha = alpha;
  return;
}
 
template <class _Result>
typename BoundaryCondition<_Result>::CoeffFunc
BoundaryCondition<_Result>::getAlpha() const
{
  return m_alpha;
}
 
template <class _Result>
typename std::remove_pointer_t<
    typename BoundaryCondition<_Result>::CoeffFunc
  >::ReturnType
BoundaryCondition<_Result>::getAlpha(CepsStandardArgs args) const
{
  if (this->hasOneOfAttributes(args.attr) or this->hasUniversalAttribute() or this->getNumberOfAttributes() == 0)
    return m_alpha->eval(std::forward<CepsStandardArgs>(args));
  return 1.;
}
 
template <class _Result>
void
BoundaryCondition<_Result>::setBeta(CoeffFunc beta)
{
  m_beta = beta;
  return;
}
 
template <class _Result>
typename BoundaryCondition<_Result>::CoeffFunc
BoundaryCondition<_Result>::getBeta() const
{
  return m_beta;
}
 
template <class _Result>
typename std::remove_pointer_t<
    typename BoundaryCondition<_Result>::CoeffFunc
  >::ReturnType
BoundaryCondition<_Result>::getBeta(CepsStandardArgs args) const
{
  if (this->hasOneOfAttributes(args.attr) or this->hasUniversalAttribute() or this->getNumberOfAttributes() == 0)
    return m_beta->eval(std::forward<CepsStandardArgs>(args));
  return 0.;
}
 
template <class _Result>
void
BoundaryCondition<_Result>::applyAsDirichlet(DMatPtr mat, DVecPtr sec, CepsReal t, CepsReal scalingFactor)
{
 
  if (ceps::isValidPtr(mat))
  {
    CepsVector<CepsIndex> indices = this->getSupportIndices();
    mat->zeroRows(indices.size(),indices.data(),scalingFactor);
  }
  if (ceps::isValidPtr(sec))
  {
    setFieldValuesTo(*this,sec.get(),t);
  }
 
  return;
}
 
template <class _Result>
_Result
BoundaryCondition<_Result>::eval(CepsStandardArgs args)
{
  if (this->hasOneOfAttributes(args.attr) or this->hasUniversalAttribute() or this->getNumberOfAttributes() == 0)
    return this->m_scaleFactor * this->m_functor->eval(std::forward<CepsStandardArgs>(args));
  return 0.;
}
 
template <class _Result>
CepsEnum 
BoundaryCondition<_Result>::getFlags() const
{
  return this->m_functor->getFlags();
}
 
// template <class _Result>
// std::ostream &
// operator<< (std::ostream &os, const BoundaryCondition<_Result> &that)
// {
//   os << static_cast<Field<_Result>> (that);
//   os << " -- type         : ";
//   switch (m_type)
//   {
//     case CepsBoundaryConditionFlag::Dirichlet: os << "Dirichlet\n"; break;
//     case CepsBoundaryConditionFlag::Neumann: os << "Neumann\n"; break;
//     case CepsBoundaryConditionFlag::Robin: os << "Robin\n"; break;
//   }
//   os << " -- alpha        : " << m_alpha.get () << "\n";
//   os << " -- beta         : " << m_beta.get () << "\n";
 
//   return os;
// }