CD_LeastSquares.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2021 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_LeastSquares_H
#define CD_LeastSquares_H
 
// Chombo includes
#include <Stencils.H>
#include <EBISBox.H>
#include <IntVectSet.H>
#include <RealVect.H>
#include <VolIndex.H>
 
// Our includes
#include <CD_VofUtils.H>
#include <CD_Location.H>
#include <CD_NamespaceHeader.H>
 
class LeastSquares
{
public:
  LeastSquares() = delete;
 
  ~LeastSquares() = delete;
 
  using CellLocation = Location::Cell;
  using FaceLocation = Location::Face;
  using Connectivity = VofUtils::Connectivity;
  using Neighborhood = VofUtils::Neighborhood;
 
  static VoFStencil
  getInterpolationStencil(const CellLocation a_cellPos,
                          const CellLocation a_otherCellsPos,
                          const Connectivity a_connectivity,
                          const VolIndex&    a_startVof,
                          const EBISBox&     a_ebisbox,
                          const Real         a_dx,
                          const int          a_p,
                          const int          a_radius,
                          const int          a_order,
                          const bool         a_addStartingVof);
 
  static VoFStencil
  getGradSten(const VolIndex&    a_vof,
              const CellLocation a_gradLocation,
              const CellLocation a_cellLocation,
              const EBISBox&     a_ebisbox,
              const Real         a_dx,
              const int          a_radius,
              const int          a_p,
              const int          a_order,
              const IntVectSet   a_knownTerms = IntVectSet());
 
  static VoFStencil
  getGradSten(const FaceIndex&   a_face,
              const FaceLocation a_gradLocation,
              const CellLocation a_cellLocation,
              const EBISBox&     a_ebisbox,
              const Real         a_dx,
              const int          a_radius,
              const int          a_p,
              const int          a_order,
              const IntVectSet   a_knownTerms = IntVectSet());
 
  static VoFStencil
  getBndryGradSten(const VolIndex&    a_vof,
                   const Neighborhood a_neighborhood,
                   const CellLocation a_cellPositions,
                   const EBISBox&     a_ebisbox,
                   const Real         a_dx,
                   const int          a_radius,
                   const int          a_p,
                   const int          a_order,
                   const bool         a_addStartingVof);
 
  static Real
  sumWeights(const VoFStencil& a_stencil, const int a_variable);
 
  static Real
  sumAllWeights(const VoFStencil& a_stencil);
 
  static VoFStencil
  projectGradSten(const VoFStencil& a_stencil, const RealVect& a_projection);
 
  static RealVect
  displacement(const CellLocation a_from,
               const CellLocation a_to,
               const VolIndex&    a_fromVof,
               const VolIndex&    a_toVof,
               const EBISBox&     a_ebisbox,
               const Real&        a_dx);
 
  static RealVect
  displacement(const FaceLocation a_fromLoc,
               const CellLocation a_toLoc,
               const FaceIndex&   a_fromFace,
               const VolIndex&    a_toVof,
               const EBISBox&     a_ebisbox,
               const Real&        a_dx);
 
  static RealVect
  displacement(const CellLocation a_from,
               const CellLocation a_to,
               const VolIndex&    a_fromVof,
               const VolIndex&    a_toVof,
               const EBISBox&     a_ebisboxFrom,
               const EBISBox&     a_ebisboxTo,
               const Real&        a_dxFrom,
               const Real&        a_dxTo);
 
  static Vector<RealVect>
  getDisplacements(const CellLocation      a_from,
                   const CellLocation      a_to,
                   const VolIndex&         a_fromVof,
                   const Vector<VolIndex>& a_toVofs,
                   const EBISBox&          a_ebisbox,
                   const Real&             a_dx);
 
  static Vector<RealVect>
  getDisplacements(const FaceLocation      a_fromLoc,
                   const CellLocation      a_to,
                   const FaceIndex&        a_fromFace,
                   const Vector<VolIndex>& a_toVofs,
                   const EBISBox&          a_ebisbox,
                   const Real&             a_dx);
 
  inline static Vector<Real>
  makeDiagWeights(const Vector<RealVect>& a_displacements, const int a_pow);
 
  static VoFStencil
  computeGradSten(const Vector<VolIndex>& a_allVofs,
                  const Vector<RealVect>& a_displacements,
                  const int               a_p,
                  const int               a_order,
                  const IntVectSet        a_knownTerms);
 
  static VoFStencil
  computeGradSten(const Vector<VolIndex>& a_allVofs,
                  const Vector<RealVect>& a_displacements,
                  const Vector<Real>&     a_weights,
                  const int               a_order,
                  const IntVectSet        a_knownTerms);
 
  static int
  getTaylorExpansionSize(const int a_order);
 
  static VoFStencil
  computeInterpolationStencil(const Vector<VolIndex>& a_allVofs,
                              const Vector<RealVect>& a_displacements,
                              const int               a_pow,
                              const int               a_order);
 
  static VoFStencil
  computeInterpolationStencil(const Vector<VolIndex>& a_allVofs,
                              const Vector<RealVect>& a_displacements,
                              const Vector<Real>&     a_weights,
                              const int               a_order);
 
  static std::map<IntVect, VoFStencil>
  computeSingleLevelStencils(const IntVectSet&       a_derivs,
                             const IntVectSet&       a_knownTerms,
                             const Vector<VolIndex>& a_allVofs,
                             const Vector<RealVect>& a_displacements,
                             const int               a_p,
                             const int               a_order);
 
  static std::map<IntVect, VoFStencil>
  computeSingleLevelStencils(const IntVectSet&       a_derivs,
                             const IntVectSet&       a_knownTerms,
                             const Vector<VolIndex>& a_allVofs,
                             const Vector<RealVect>& a_displacements,
                             const Vector<Real>&     a_weights,
                             const int               a_order);
 
  template <typename T>
  static std::map<IntVect, std::pair<VoFStencil, VoFStencil>>
  computeDualLevelStencils(const IntVectSet&       a_derivs,
                           const IntVectSet&       a_knownTerms,
                           const Vector<VolIndex>& a_fineVofs,
                           const Vector<VolIndex>& a_coarVofs,
                           const Vector<RealVect>& a_fineDisplacements,
                           const Vector<RealVect>& a_coarDisplacements,
                           const int               a_p,
                           const int               a_order);
 
  template <typename T>
  static std::map<IntVect, std::pair<VoFStencil, VoFStencil>>
  computeDualLevelStencils(const IntVectSet&       a_derivs,
                           const IntVectSet&       a_knownTerms,
                           const Vector<VolIndex>& a_fineVofs,
                           const Vector<VolIndex>& a_coarVofs,
                           const Vector<RealVect>& a_fineDisplacements,
                           const Vector<RealVect>& a_coarDisplacements,
                           const Vector<Real>&     a_fineWeights,
                           const Vector<Real>&     a_coarWeights,
                           const int               a_order);
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_LeastSquaresImplem.H>
 
#endif