FluxAnodeCathodeProblem.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/static/FluxAnodeCathodeProblem.hpp"
#include "pde/solver/static/FluxAnodeCathodeSolver.hpp"
 
FluxAnodeCathodeProblem::FluxAnodeCathodeProblem(Geometry* g, InputParameters* p) : 
  DirichletAnodeCathodeProblem (g,p)
{
  setProblemName("Flux Anode Cathode");
 
  FluxAnodeCathodeProblem::setupWithParameters(m_parameters);
}
 
FluxAnodeCathodeProblem::~FluxAnodeCathodeProblem()
{
}
 
void 
FluxAnodeCathodeProblem::setupWithParameters(InputParameters* p)
{
  DirichletAnodeCathodeProblem::setupWithParameters(p);
 
  m_robinCoeffs = p->getString("robin coefficients", "");
}
 
 
void
FluxAnodeCathodeProblem::defineUnknowns()
{
  // A single spatial unknown defined everywhere
  addUnknown("u");
 
  if (requireNullMean())
  {
    // and a lagrangian unknown
    addZeroDUnknown("lambda");
    addUnknownInteraction("lambda", "u");
    m_ignoreZeroDError = true; // Ignore the Lagrangian multiplier in error computation
  }
}
 
void
FluxAnodeCathodeProblem::defineSourceTerms()
{
}
 
void
FluxAnodeCathodeProblem::defineBoundaryConditions()
{
  std::stringstream ssa,ssc;
  for (CepsAttribute a: m_anode->getAttributes())
    ssa << a << " ";
  for (CepsAttribute a: m_cathode->getAttributes())
    ssc << a << " ";
 
  m_boundaryConditions->add("anode NEUMANN 1.0 UNKNOWN 0 ATTRIBUTES " + ssa.str());
  m_boundaryConditions->add("cathode NEUMANN -1.0 UNKNOWN 0 ATTRIBUTES " + ssc.str());
 
  for (auto definition : ceps::split(m_robinCoeffs, ","))
  {
    auto options = ceps::split(definition);
    CEPS_ABORT_IF(options.size() != 2, "robin coefficient entry requires a scalar and an attribute");
    m_boundaryConditions->add("boundary ROBIN 0.0 UNKNOWN 0 ATTRIBUTES " + options[1] + " ROBINCOEFF " + options[0]);
  }
}
 
void 
FluxAnodeCathodeProblem::defineAnalyticSolution()
{
}
 
void
FluxAnodeCathodeProblem::run()
{
 
  if (ceps::isProfiling())
    getProfiler()->start("whole","solving the whole PDE");
 
  initializeEquation();
 
  FluxAnodeCathodeSolver solver(this);
  
  solver.solve(); 
 
  if (hasAnalyticSolution())
    m_errors = solver.getErrors();
 
  if (ceps::isProfiling())
    getProfiler()->stop("whole");  
}
 
CepsBool
FluxAnodeCathodeProblem::requireNullMean() const
{
  return m_robinCoeffs.empty();
}