DegreeOfFreedom.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 "pde/common/Unknown.hpp"
 
class DegreeOfFreedom :
    public ceps::HoldsGlobalIndex,
    public ceps::HoldsBoundary,
    public ceps::HoldsProcIds,
    public ceps::HoldsAttributes
{
  public:
    DegreeOfFreedom() = delete;
 
    DegreeOfFreedom(
      Unknown*                      unknown,
      const CepsSet<CepsAttribute>& attrs,
      CepsGlobalIndex               geomId,
      CepsIndex                     dofId  = CepsUniversal,
      CepsProcId                    procId = ceps::getRank(),
      CepsSet<DegreeOfFreedom*>     neighs = {}
    );
 
    DegreeOfFreedom(const DegreeOfFreedom&) = delete;
 
    DegreeOfFreedom&
    operator=(const DegreeOfFreedom&) = delete;
 
    ~DegreeOfFreedom() = default;
 
    // --------------------------------------------------------------------------------
    // Unknown
    // --------------------------------------------------------------------------------
 
    void
    setUnknown(Unknown* unknown);
 
    Unknown*
    getUnknown() const;
 
    const CepsLocationFlag &
    getLocation() const;
 
    // --------------------------------------------------------------------------------
    // Geometric
    // --------------------------------------------------------------------------------
 
    void
    setGeomId(CepsGlobalIndex geomId);
 
    const CepsGlobalIndex &
    getGeomId() const;
 
    void
    setDiscrId(CepsGlobalIndex discrId);
 
    const CepsGlobalIndex &
    getDiscrId() const;
 
    void
    setVertex(CepsVertex* vertex);
 
    CepsVertex*
    getVertex() const;
 
    // --------------------------------------------------------------------------------
    // Neighboors
    // --------------------------------------------------------------------------------
 
    void
    addNeighbor(DegreeOfFreedom* x);
 
    CepsUInt
    getNumberOfNeighbors() const;
 
    const CepsSet<DegreeOfFreedom*> &
    getNeighbors() const;
 
 
  protected:
 
    Unknown* m_unknown;
 
    CepsGlobalIndex m_geomId; 
 
    CepsGlobalIndex m_discrId;
 
    CepsVertex* m_vertex;
 
    CepsSet<DegreeOfFreedom*> m_neigh;
};
 
CepsStandardArgs
getStandardArgsFrom(DegreeOfFreedom* dof);