DegreeOfFreedom.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/common/DegreeOfFreedom.hpp"
 
DegreeOfFreedom::DegreeOfFreedom (
  Unknown*                      unknown,
  const CepsSet<CepsAttribute>& attrs,
  CepsGlobalIndex               geomId,
  CepsIndex                     dofId,
  CepsProcId                    procId,
  CepsSet<DegreeOfFreedom*>     neighs
) :
    ceps::HoldsGlobalIndex(dofId),
    ceps::HoldsBoundary(false),
    ceps::HoldsProcIds(procId),
    ceps::HoldsAttributes(attrs),
    m_unknown(unknown),
    m_geomId(geomId),
    m_discrId(geomId),
    m_vertex(nullptr),
    m_neigh(neighs)
{
  CEPS_ABORT_IF (ceps::isNullPtr(m_unknown),
    "A degree of freedom must be defined with a valid unknown"
  );    
}
 
void
DegreeOfFreedom::setUnknown (Unknown *unknown)
{
  m_unknown = unknown;
  return;
}
 
Unknown *
DegreeOfFreedom::getUnknown () const
{
  return m_unknown;
}
 
const CepsLocationFlag &
DegreeOfFreedom::getLocation () const
{
  return m_unknown->getLocation ();
}
 
void
DegreeOfFreedom::setGeomId (CepsGlobalIndex geomId)
{
  m_geomId = geomId;
  return;
}
 
const CepsGlobalIndex &
DegreeOfFreedom::getGeomId () const
{
  return m_geomId;
}
 
void
DegreeOfFreedom::setDiscrId(CepsGlobalIndex discrId)
{
  m_discrId = discrId;
  return;
}
 
const CepsGlobalIndex &
DegreeOfFreedom::getDiscrId () const
{
  return m_discrId;
}
 
void
DegreeOfFreedom::setVertex (CepsVertex *vertex)
{
  m_vertex = vertex;
  return;
}
 
CepsVertex *
DegreeOfFreedom::getVertex () const
{
  return m_vertex;
}
 
void
DegreeOfFreedom::addNeighbor (DegreeOfFreedom *x)
{
  m_neigh.insert (x);
  return;
}
 
CepsUInt
DegreeOfFreedom::getNumberOfNeighbors () const
{
  return m_neigh.size ();
}
 
const CepsSet<DegreeOfFreedom *> &
DegreeOfFreedom::getNeighbors () const
{
  return m_neigh;
}
 
CepsStandardArgs
getStandardArgsFrom(DegreeOfFreedom* dof)
{
  CEPS_ABORT_IF(ceps::isNullPtr(dof),
    "Passed DegreeOfFreedom is nullptr"
  );
  CepsStandardArgs args;
  if (dof->getLocation() != CepsLocationFlag::ZeroD)
    args.x         = dof->getVertex()->getCoordinates();
  args.dofId     = dof->getGlobalIndex();
  args.attr      = dof->getAttributes();
  args.unknownId = dof->getUnknown()->getIdentifier();
  if (dof->getLocation() == CepsLocationFlag::Point)
    args.nodeId = dof->getGeomId();
  else if (dof->getLocation() == CepsLocationFlag::Cell)
    args.cellId = dof->getGeomId();
  return args;
}