AbstractDiscretization.hpp

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
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/CepsCommon.hpp"
#include "geometry/Geometry.hpp"
#include "pde/common/DegreeOfFreedom.hpp"
#include "pde/common/DistributedFactory.hpp"
#include "pde/common/functions/SAFunc.hpp"
 
 
class AbstractPdeProblem;
 
using DegreeOfFreedomTree = CepsArray<
  CepsMap<
    CepsGlobalIndex,
    CepsVector<DegreeOfFreedom*>>,
  CepsLocationFlagSize>;
 
class AbstractDiscretization : public CepsObject
{
  public:
    AbstractDiscretization() = delete;
 
    AbstractDiscretization (const AbstractDiscretization& that) = delete;
 
    AbstractDiscretization&
    operator=(const AbstractDiscretization&) = delete;
 
    ~AbstractDiscretization() override;
 
    AbstractPdeProblem*
    getProblem() const;
 
    DistributedFactory*
    getDofsFactory() const;
 
    DistributedInfos<DegreeOfFreedom*>*
    getDistributedDofs() const;
 
    const DegreeOfFreedomTree&
    getDegreeOfFreedomTree() const;
 
    const CepsMap<CepsUnknownIndex,CepsVector<DegreeOfFreedom*>>&
    getDegreesOfFreedomForUnknown();
 
    const CepsVector<DegreeOfFreedom*>&
    getDegreesOfFreedomForUnknown(CepsUnknownIndex uId);
 
    const CepsVector<DegreeOfFreedom*>&
    getDegreesOfFreedomForUnknown(Unknown* u);
 
    Geometry*
    getGeometry() const;
 
    virtual void
    registerSpatialUnkown(Unknown* u);
 
    // ------------------------------------------------------
    // Methods related to degrees of freedom management
 
    DVecPtr
    newDofVector() const;
 
    DHVecPtr
    newDofHaloVector() const;
 
    DMatPtr
    newDofMatrix() const;
 
    DegreeOfFreedom*
    getDof(CepsGlobalIndex globalDofId);
 
    const DegreeOfFreedom*
    getDof(CepsGlobalIndex globalDofId) const;
 
    CepsBool
    isDofSpatial(CepsGlobalIndex globalDofId) const;
 
    virtual CepsIndex
    getDofSpatialId(const DegreeOfFreedom* dof) const = 0;
 
    CepsVector<DegreeOfFreedom*>
    getOwnedDofs() const;
 
    CepsVector<DegreeOfFreedom*>
    getHaloDofs() const;
 
    virtual void
    extractValuesForUnknown(
      const CepsUnknownIndex& uId,
      DVecPtr                 vec,
      CepsVector<CepsIndex>&  indices,
      CepsVector<CepsReal>&   values,
      CepsBool                sendToMaster = false,
      CepsBool                returnGeomIndices = false
 
    ) = 0;
 
    void
    evaluateFunctionOnDofs(
      ceps::Function<CepsReal(CepsStandardArgs)>* func, 
      DHVecPtr v, 
      CepsReal t=0.
    ) const;
 
    void
    findClosestDof(const CepsReal3D& x, Unknown* u, CepsDofGlobalIndex& dofId, CepsProcId& owner);
 
    CepsReal
    getZeroDValue(Unknown* u, DHVecPtr sol);
 
    // ========== METRICS ================================================================
 
    virtual CepsReal
    dotProduct(
      DHVecPtr                      u,
      DHVecPtr                      v,
      CepsBool                      boundary = false,
      const CepsSet<CepsAttribute>& attrs    = {},
      const CepsVector<Unknown*>&   unknowns = {}
    ) = 0;
 
    CepsReal
    l1Norm(
      DHVecPtr                      v,
      CepsBool                      boundary = false,
      const CepsSet<CepsAttribute>& attrs    = {},
      const CepsVector<Unknown*>&   unknowns = {}
    );
 
    CepsReal
    l2Norm(
      DHVecPtr                      v,
      CepsBool                      boundary = false,
      const CepsSet<CepsAttribute>& attrs    = {},
      const CepsVector<Unknown*>&   unknowns = {}
    );
 
    virtual CepsReal
    h1Norm(
      DHVecPtr                      v,
      CepsBool                      boundary = false,
      const CepsSet<CepsAttribute>& attrs    = {},
      const CepsVector<Unknown*>&   unknowns = {}
    ) = 0;
 
 
  protected:
 
    AbstractDiscretization (AbstractPdeProblem* problem);
 
    void 
    buildDofs();
 
    virtual void 
    buildDofsTree() = 0;
 
    void 
    buildDofsDistributedInfo();
 
    void 
    createDofsForZeroDUnknowns();
 
    virtual void
    setSpatialUnknownsDofsInteractions() = 0;
 
    virtual void
    setZeroDUnknownsDofsInteractions();
 
    void
    setupDofsFactory();
 
    void
    extractValuesForUnknownInternal(
      const CepsUnknownIndex&                    uId,
      DVecPtr                                    vec,
      CepsVector<CepsIndex>&                     indices,
      CepsVector<CepsReal>&                      values,
      CepsBool                                   sendToMaster,
      CepsBool                                   returnGeomIndices,
      std::function<CepsBool(DegreeOfFreedom*)>& selector
    );
 
 
 
    AbstractPdeProblem* m_problem;
    Geometry* m_geometry;
 
    // Dofs
 
    DistributedInfos<DegreeOfFreedom*>* m_distributedDofs;
    DegreeOfFreedomTree m_dofsTree;
    DistributedFactory* m_dofsFactory;
    CepsBool m_dofsBuilt;
    CepsMap<CepsUnknownIndex,CepsVector<DegreeOfFreedom*>> m_dofsForUnknown;
 
    CepsLocationFlag m_spatialUnknownsLocation;
 
    CepsVector<CepsMap<CepsDofGlobalIndex,CepsSet<CepsDofGlobalIndex>>> m_extraAdjacencyToSend;
    CepsMap<CepsDofGlobalIndex,CepsSet<CepsDofGlobalIndex>>             m_extraAdjacencyToRecv;
 
};