AbstractTimedPdeProblem.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/problem/timed/AbstractTimedPdeProblem.hpp"
#include "pde/finiteElements/FiniteElements.hpp"
#include "pde/common/functions/FileInterpolatorSAFunc.hpp"
 
 
AbstractTimedPdeProblem::AbstractTimedPdeProblem(
  Geometry*        geom, 
  InputParameters* params
):
  AbstractPdeProblem(geom,params),
  m_pdeStartTime(0.),
  m_pdeEndTime(1.),
  m_pdeTimeStep(0.1),
  m_pdeSnapshotTime(0.1)
{
  if (m_parameters)
    AbstractTimedPdeProblem::setupWithParameters(m_parameters);
}
 
void
AbstractTimedPdeProblem::setupWithParameters(InputParameters* params)
{
  setTimes(params->getReal("pde start time",m_pdeStartTime),
           params->getReal("pde end time"  ,m_pdeEndTime  ),
           params->getReal("pde time step" ,m_pdeTimeStep ));
  setSnapshotTime(params->getReal("output period",m_pdeSnapshotTime));
}
 
CepsReal
AbstractTimedPdeProblem::getStartTime() const
{
  return m_pdeStartTime;
}
 
CepsReal
AbstractTimedPdeProblem::getEndTime() const
{
  return m_pdeEndTime;
}
 
CepsReal
AbstractTimedPdeProblem::getTimeStep() const
{
  return m_pdeTimeStep;
}
 
void
AbstractTimedPdeProblem::setTimes(CepsReal tStart, CepsReal tEnd, CepsReal dt)
{
  m_pdeStartTime = std::min(tStart,tEnd);
  m_pdeEndTime   = std::max(tStart,tEnd);
  m_pdeTimeStep  = std::fabs(dt);
  CEPS_ABORT_IF(ceps::equals(dt,0.),
    "Pde time step must be strictly positive"
  );
}
 
CepsReal
AbstractTimedPdeProblem::getSnapshotTime() const
{
  return m_pdeSnapshotTime;
}
 
void
AbstractTimedPdeProblem::setSnapshotTime(CepsReal time)
{
  m_pdeSnapshotTime = std::abs(time);
  CEPS_WARNS_IF(m_pdeSnapshotTime<m_pdeTimeStep,
    "Pde output periodicity is lower than time step, output will be set to 1 per time step"
  );
  m_pdeSnapshotTime = std::max(m_pdeSnapshotTime,m_pdeTimeStep);
  CEPS_ABORT_IF(ceps::equals(time,0.),
    "Pde output periodicity must be strictly positive"
  );
}
 
void
AbstractTimedPdeProblem::defineInitialCondition()
{
  m_initialCondition = nullptr;
}
 
void
AbstractTimedPdeProblem::getInitialCondition(DHVecPtr v) const
{
  v->zero();
  if (ceps::isValidPtr(m_initialCondition))
    m_discr->evaluateFunctionOnDofs(m_initialCondition,v,getStartTime());
}
 
void
AbstractTimedPdeProblem::initializeEquation()
{
  AbstractPdeProblem::initializeEquation();
  this->defineInitialCondition();
}
 
CepsArray2<CepsArray3<CepsArray3<CepsReal>>>
AbstractTimedPdeProblem::getErrors() const
{
  return m_errors;
}
 
CepsBool
AbstractTimedPdeProblem::canComputeErrorAtTime(CepsReal t) const
{
  if (not hasAnalyticSolution())
    return false;
  if (m_refSolFiles.empty())
    return true;
  CepsReal tt = (t-m_pdeStartTime)/m_refSolSnapDt;
  return std::abs(tt-std::round(tt)) < 1.e-3;
}