chombo-discharge
Loading...
Searching...
No Matches
CD_LeastSquares.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_LEASTSQUARES_H
14#define CD_LEASTSQUARES_H
15
16// Chombo includes
17#include <Stencils.H>
18#include <EBISBox.H>
19#include <IntVectSet.H>
20#include <RealVect.H>
21#include <VolIndex.H>
22
23// Our includes
24#include <CD_VofUtils.H>
25#include <CD_Location.H>
26#include <CD_NamespaceHeader.H>
27
31class LeastSquares
32{
33public:
37 LeastSquares() = delete;
38
42 ~LeastSquares() = delete;
43
45 using CellLocation = Location::Cell;
47 using FaceLocation = Location::Face;
49 using Connectivity = VofUtils::Connectivity;
51 using Neighborhood = VofUtils::Neighborhood;
52
67 static VoFStencil
68 getInterpolationStencil(CellLocation a_cellPos,
69 CellLocation a_otherCellsPos,
70 Connectivity a_connectivity,
71 const VolIndex& a_startVof,
72 const EBISBox& a_ebisbox,
73 Real a_dx,
74 int a_p,
75 int a_radius,
76 int a_order,
77 bool a_addStartingVof);
78
93 static VoFStencil
94 getGradSten(const VolIndex& a_vof,
95 CellLocation a_gradLocation,
96 CellLocation a_cellLocation,
97 const EBISBox& a_ebisbox,
98 Real a_dx,
99 int a_radius,
100 int a_p,
101 int a_order,
102 const IntVectSet& a_knownTerms = IntVectSet());
103
118 static VoFStencil
119 getGradSten(const FaceIndex& a_face,
120 FaceLocation a_gradLocation,
121 CellLocation a_cellLocation,
122 const EBISBox& a_ebisbox,
123 Real a_dx,
124 int a_radius,
125 int a_p,
126 int a_order,
127 const IntVectSet& a_knownTerms = IntVectSet());
128
143 static VoFStencil
144 getBndryGradSten(const VolIndex& a_vof,
145 Neighborhood a_neighborhood,
146 CellLocation a_cellPositions,
147 const EBISBox& a_ebisbox,
148 Real a_dx,
149 int a_radius,
150 int a_p,
151 int a_order,
152 bool a_addStartingVof);
153
160 static Real
161 sumWeights(const VoFStencil& a_stencil, int a_variable);
162
168 static Real
169 sumAllWeights(const VoFStencil& a_stencil);
170
178 static VoFStencil
179 projectGradSten(const VoFStencil& a_stencil, const RealVect& a_projection);
180
191 static RealVect
192 displacement(CellLocation a_from,
193 CellLocation a_to,
194 const VolIndex& a_fromVof,
195 const VolIndex& a_toVof,
196 const EBISBox& a_ebisbox,
197 const Real& a_dx);
198
209 static RealVect
210 displacement(FaceLocation a_fromLoc,
211 CellLocation a_toLoc,
212 const FaceIndex& a_fromFace,
213 const VolIndex& a_toVof,
214 const EBISBox& a_ebisbox,
215 const Real& a_dx);
216
229 static RealVect
230 displacement(CellLocation a_from,
231 CellLocation a_to,
232 const VolIndex& a_fromVof,
233 const VolIndex& a_toVof,
234 const EBISBox& a_ebisboxFrom,
235 const EBISBox& a_ebisboxTo,
236 const Real& a_dxFrom,
237 const Real& a_dxTo);
238
249 static Vector<RealVect>
250 getDisplacements(CellLocation a_from,
251 CellLocation a_to,
252 const VolIndex& a_fromVof,
253 const Vector<VolIndex>& a_toVofs,
254 const EBISBox& a_ebisbox,
255 const Real& a_dx);
256
267 static Vector<RealVect>
268 getDisplacements(FaceLocation a_fromLoc,
269 CellLocation a_to,
270 const FaceIndex& a_fromFace,
271 const Vector<VolIndex>& a_toVofs,
272 const EBISBox& a_ebisbox,
273 const Real& a_dx);
274
282 inline static Vector<Real>
283 makeDiagWeights(const Vector<RealVect>& a_displacements, int a_pow);
284
296 static VoFStencil
297 computeGradSten(const Vector<VolIndex>& a_allVofs,
298 const Vector<RealVect>& a_displacements,
299 int a_p,
300 int a_order,
301 const IntVectSet& a_knownTerms);
302
315 static VoFStencil
316 computeGradSten(const Vector<VolIndex>& a_allVofs,
317 const Vector<RealVect>& a_displacements,
318 const Vector<Real>& a_weights,
319 int a_order,
320 const IntVectSet& a_knownTerms);
321
327 static int
328 getTaylorExpansionSize(int a_order);
329
339 static VoFStencil
340 computeInterpolationStencil(const Vector<VolIndex>& a_allVofs,
341 const Vector<RealVect>& a_displacements,
342 int a_pow,
343 int a_order);
344
355 static VoFStencil
356 computeInterpolationStencil(const Vector<VolIndex>& a_allVofs,
357 const Vector<RealVect>& a_displacements,
358 const Vector<Real>& a_weights,
359 int a_order);
360
379 static std::map<IntVect, VoFStencil>
380 computeSingleLevelStencils(const IntVectSet& a_derivs,
381 const IntVectSet& a_knownTerms,
382 const Vector<VolIndex>& a_allVofs,
383 const Vector<RealVect>& a_displacements,
384 int a_p,
385 int a_order);
386
406 static std::map<IntVect, VoFStencil>
407 computeSingleLevelStencils(const IntVectSet& a_derivs,
408 const IntVectSet& a_knownTerms,
409 const Vector<VolIndex>& a_allVofs,
410 const Vector<RealVect>& a_displacements,
411 const Vector<Real>& a_weights,
412 int a_order);
413
437 template <typename T>
438 static std::map<IntVect, std::pair<VoFStencil, VoFStencil>>
439 computeDualLevelStencils(const IntVectSet& a_derivs,
440 const IntVectSet& a_knownTerms,
441 const Vector<VolIndex>& a_fineVofs,
442 const Vector<VolIndex>& a_coarVofs,
443 const Vector<RealVect>& a_fineDisplacements,
444 const Vector<RealVect>& a_coarDisplacements,
445 int a_p,
446 int a_order);
447
472 template <typename T>
473 static std::map<IntVect, std::pair<VoFStencil, VoFStencil>>
474 computeDualLevelStencils(const IntVectSet& a_derivs,
475 const IntVectSet& a_knownTerms,
476 const Vector<VolIndex>& a_fineVofs,
477 const Vector<VolIndex>& a_coarVofs,
478 const Vector<RealVect>& a_fineDisplacements,
479 const Vector<RealVect>& a_coarDisplacements,
480 const Vector<Real>& a_fineWeights,
481 const Vector<Real>& a_coarWeights,
482 int a_order);
483};
484
485#include <CD_NamespaceFooter.H>
486
487#include <CD_LeastSquaresImplem.H>
488
489#endif
CD_LeastSquaresImplem.H
Implementation of CD_LeastSquares.H.
CD_Location.H
Declaration of cell positions.
CD_VofUtils.H
Various functions for getting Vofs near cut-cells.
LeastSquares
Static class containing useful routines for (weighted) least squares polynomial reconstruction.
Definition CD_LeastSquares.H:32
LeastSquares::computeGradSten
static VoFStencil computeGradSten(const Vector< VolIndex > &a_allVofs, const Vector< RealVect > &a_displacements, int a_p, int a_order, const IntVectSet &a_knownTerms)
Get a least squares gradient stencil solution for computing the gradient at a point....
Definition CD_LeastSquares.cpp:321
LeastSquares::sumWeights
static Real sumWeights(const VoFStencil &a_stencil, int a_variable)
Return the sum of weights in the stencil, for a specific variable.
Definition CD_LeastSquares.cpp:392
LeastSquares::computeInterpolationStencil
static VoFStencil computeInterpolationStencil(const Vector< VolIndex > &a_allVofs, const Vector< RealVect > &a_displacements, int a_pow, int a_order)
Compute an interpolation stencil to specified order by solving a least squares system.
Definition CD_LeastSquares.cpp:429
LeastSquares::makeDiagWeights
static Vector< Real > makeDiagWeights(const Vector< RealVect > &a_displacements, int a_pow)
Create a list of weights. This routine returns a list of diagonal weights for a least squares system....
Definition CD_LeastSquaresImplem.H:23
LeastSquares::sumAllWeights
static Real sumAllWeights(const VoFStencil &a_stencil)
Compute the sum of all weights in a stencil.
Definition CD_LeastSquares.cpp:408
LeastSquares::getBndryGradSten
static VoFStencil getBndryGradSten(const VolIndex &a_vof, Neighborhood a_neighborhood, CellLocation a_cellPositions, const EBISBox &a_ebisbox, Real a_dx, int a_radius, int a_p, int a_order, bool a_addStartingVof)
Compute a least squares gradient stencil on the EB centroid with specified order.
Definition CD_LeastSquares.cpp:157
LeastSquares::getDisplacements
static Vector< RealVect > getDisplacements(CellLocation a_from, CellLocation a_to, const VolIndex &a_fromVof, const Vector< VolIndex > &a_toVofs, const EBISBox &a_ebisbox, const Real &a_dx)
Get displacement vectors from a cell position to another cell position for a list of Vofs,...
Definition CD_LeastSquares.cpp:282
LeastSquares::projectGradSten
static VoFStencil projectGradSten(const VoFStencil &a_stencil, const RealVect &a_projection)
Assuming that a_stencil is a gradient stencil, project it along a direction.
Definition CD_LeastSquares.cpp:374
LeastSquares::~LeastSquares
~LeastSquares()=delete
Static class, no destruction here.
LeastSquares::displacement
static RealVect displacement(CellLocation a_from, CellLocation a_to, const VolIndex &a_fromVof, const VolIndex &a_toVof, const EBISBox &a_ebisbox, const Real &a_dx)
Computes the distance between two Vofs that are defined on the same grid level.
Definition CD_LeastSquares.cpp:236
LeastSquares::computeSingleLevelStencils
static std::map< IntVect, VoFStencil > computeSingleLevelStencils(const IntVectSet &a_derivs, const IntVectSet &a_knownTerms, const Vector< VolIndex > &a_allVofs, const Vector< RealVect > &a_displacements, int a_p, int a_order)
Compute a least squares interpolation to a specified order.
Definition CD_LeastSquares.cpp:467
LeastSquares::getInterpolationStencil
static VoFStencil getInterpolationStencil(CellLocation a_cellPos, CellLocation a_otherCellsPos, Connectivity a_connectivity, const VolIndex &a_startVof, const EBISBox &a_ebisbox, Real a_dx, int a_p, int a_radius, int a_order, bool a_addStartingVof)
Get an interpolation stencil to a point in a cell with a specified order and radius.
Definition CD_LeastSquares.cpp:20
LeastSquares::LeastSquares
LeastSquares()=delete
Static class, no construction here.
LeastSquares::getGradSten
static VoFStencil getGradSten(const VolIndex &a_vof, CellLocation a_gradLocation, CellLocation a_cellLocation, const EBISBox &a_ebisbox, Real a_dx, int a_radius, int a_p, int a_order, const IntVectSet &a_knownTerms=IntVectSet())
Compute a least squares gradient stencil in a cell.
Definition CD_LeastSquares.cpp:58
LeastSquares::computeDualLevelStencils
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, int a_p, int a_order)
Compute a least squares interpolation to a specified order. This version separates the stencils into ...
Definition CD_LeastSquaresImplem.H:49
LeastSquares::getTaylorExpansionSize
static int getTaylorExpansionSize(int a_order)
Get the size of a Taylor expansion for a given order.
Definition CD_LeastSquares.cpp:420
TracerParticleSolver
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38
TracerParticleSolver::TracerParticleSolver
TracerParticleSolver()
Default constructor.
Definition CD_TracerParticleSolverImplem.H:26
VofUtils::Neighborhood
Neighborhood
Neighborhood type.
Definition CD_VofUtils.H:56
VofUtils::Connectivity
Connectivity
Class for specifying connectivity of Vofs.
Definition CD_VofUtils.H:43
Location::Cell
Cell
Enum for distinguishing between cell locations.
Definition CD_Location.H:31
Location::Face
Face
Enum for distinguishing between face locations.
Definition CD_Location.H:41
Generated by doxygen 1.9.8