CD_PetscAMRCell.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_PETSCAMRCELL_H
#define CD_PETSCAMRCELL_H
 
#ifdef CH_USE_PETSC
 
// Petsc includes
#include "petsc.h"
 
// Chombo includes
#include <SPMD.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class PetscAMRCell
{
public:
  PetscAMRCell() noexcept;
 
  ~PetscAMRCell() noexcept;
 
  PetscAMRCell(const PetscAMRCell&) = default;
 
  PetscAMRCell(PetscAMRCell&&) = default;
 
  PetscAMRCell&
  operator=(const PetscAMRCell&) = default;
 
  PetscAMRCell&
  operator=(PetscAMRCell&&) = default;
 
  void
  define(const PetscInt a_petscRowPhase0,
         const PetscInt a_petscRowPhase1,
         const bool     a_isCoveredByFinerGrid,
         const bool     a_isCoarCF,
         const bool     a_isFineCF,
         const bool     a_isGhostCF,
         const bool     a_isDomainBoundaryCell) noexcept;
 
  void
  setPetscRow(const int a_phase, const PetscInt a_row) noexcept;
 
  void
  setCoveredByFinerGrid(const bool a_coveredByFinerGrid) noexcept;
 
  void
  setCoarCF(const bool a_isCoarCF) noexcept;
 
  void
  setFineCF(const bool a_isFineCF) noexcept;
 
  void
  setGhostCF(const bool a_isGhostCF) noexcept;
 
  void
  setDomainBoundaryCell(const bool a_isDomainBoundaryCell) noexcept;
 
  PetscInt
  getPetscRow(const int a_iphase) const noexcept;
 
  bool
  isCoveredByFinerGrid() const noexcept;
 
  bool
  isCoarCF() const noexcept;
 
  bool
  isFineCF() const noexcept;
 
  bool
  isGhostCF() const noexcept;
 
  bool
  isDomainBoundaryCell() const noexcept;
 
  PetscInt m_petscRows[2];
 
  bool m_isCoveredByFinerGrid;
 
  bool m_isGhostCF;
 
  bool m_isCoarCF;
 
  bool m_isFineCF;
 
  bool m_isDomainBoundaryCell;
};
 
constexpr int
linearSize(const PetscAMRCell& a_amrCell);
 
void
linearIn(PetscAMRCell& a_amrCell, const void* const a_buffer);
 
void
linearOut(void* const a_buffer, const PetscAMRCell& a_amrCell);
 
#include <CD_NamespaceFooter.H>
 
#endif
 
#endif