chombo-discharge
Loading...
Searching...
No Matches
CD_ScanShop.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_SCANSHOP_H
14#define CD_SCANSHOP_H
15
16// Chombo includes
17#include <GeometryShop.H>
18#include <GeometryService.H>
19
20// Our includes
21#include <CD_Timer.H>
22#include <CD_BoxSorting.H>
23#include <CD_NamespaceHeader.H>
24
30class ScanShop : public GeometryShop
31{
32public:
36 ScanShop() = delete;
37
49 ScanShop(const BaseIF& a_localGeom,
50 int a_verbosity,
51 Real a_dx,
52 const RealVect& a_probLo,
55 int a_ebGhost = 4,
56 Real a_thrshdVoF = 1.0e-16);
57
61 ~ScanShop() override;
62
66 ScanShop(const ScanShop&) = delete;
67
72 operator=(const ScanShop&) = delete;
73
77 ScanShop(ScanShop&&) = delete;
78
83 operator=(ScanShop&&) = delete;
84
85 using GeometryShop::InsideOutside;
86 using GeometryShop::isCovered;
87 using GeometryShop::isRegular;
88
93 void
95
104 void
107 const int& a_maxGridSize,
108 const int& a_maxIrregGridSize) override;
109
123 const ProblemDomain& a_domain,
124 const RealVect& a_probLo,
125 const Real& a_dx,
126 const DataIndex& a_dit) const override;
127
140 void
143 const Box& a_validRegion,
144 const Box& a_ghostRegion,
145 const ProblemDomain& a_domain,
146 const RealVect& a_probLo,
147 const Real& a_dx,
148 const DataIndex& a_di) const override;
149
150protected:
155
160
164 mutable Timer m_timer;
165
170
175
180
185
189 const BaseIF* m_baseIF;
190
195
200
205
210
216
221
229 void
231 const RealVect& a_probLo,
234
240 void
242
250 void
252
259 inline bool
260 isRegular(Box a_box, const RealVect& a_probLo, Real a_dx) const;
261
269 inline bool
270 isCovered(Box a_box, const RealVect& a_probLo, Real a_dx) const;
271
281
289 void
291};
292
293#include <CD_NamespaceFooter.H>
294
295#include <CD_ScanShopImplem.H>
296
297#endif
Declaration of an enum for identifying various ways of sorting grid patches.
BoxSorting
Enum for sorting boxes.
Definition CD_BoxSorting.H:22
Implementation of CD_Timer.H.
Derived version of GeometryShop that load balances based on the cut cells themselves.
Definition CD_ScanShop.H:31
void setProfileFileName(std::string a_fileName)
If doing profiling, set the output name.
Definition CD_ScanShop.cpp:85
Vector< RefCountedPtr< LayoutData< GeometryService::InOut > > > m_boxMap
Box maps.
Definition CD_ScanShop.H:215
Vector< Real > m_dx
Level resolutions. Note that index 0 is the finest level.
Definition CD_ScanShop.H:199
ScanShop(const ScanShop &)=delete
Disallow copy construction.
std::string m_fileName
Set output file name (if doing profiling)
Definition CD_ScanShop.H:154
void buildFinerLevels(int a_coarserLevel, int a_maxGridSize)
Refine levels recursively down to the finest level.
Definition CD_ScanShop.cpp:273
void makeDomains(Real a_dx, const RealVect &a_probLo, const ProblemDomain &a_finestDomain, const ProblemDomain &a_scanLevel)
Create the problem domain and resolutions.
Definition CD_ScanShop.cpp:93
int m_scanLevel
Scan level where we first begin to break up boxes. This is relative the EBIS level.
Definition CD_ScanShop.H:174
int m_ebGhost
Maximum number of ghost cells near the EB.
Definition CD_ScanShop.H:179
BoxSorting m_boxSorting
For arranging boxes in space when we load balance.
Definition CD_ScanShop.H:159
void makeGrids(const ProblemDomain &a_domain, DisjointBoxLayout &a_grids, const int &a_maxGridSize, const int &a_maxIrregGridSize) override
This grid generation method is called by EBISLevel when using distributed data.
Definition CD_ScanShop.cpp:136
void defineLevel(Vector< Box > &coveredBoxes, Vector< Box > &regularBoxes, Vector< Box > &cutCellBoxes, int a_level)
Define the "box map" on a specified level.
Definition CD_ScanShop.cpp:362
bool isRegular(Box a_box, const RealVect &a_probLo, Real a_dx) const
Check if every point in input box is regular.
Definition CD_ScanShopImplem.H:23
void buildCoarseLevel(int a_level, int a_maxGridSize)
Build the "coarse level" where we initiate the recursion process.
Definition CD_ScanShop.cpp:198
Vector< DisjointBoxLayout > m_grids
Grids on each level, used for generating the EBIS information.
Definition CD_ScanShop.H:209
~ScanShop() override
Destructor (does nothing)
Definition CD_ScanShop.cpp:74
bool m_profile
Bool for run-time profiling of ScanShop.
Definition CD_ScanShop.H:169
std::vector< std::pair< Box, int > > getSortedBoxesAndTypes(const Vector< Box > &a_boxes, const Vector< int > &a_types) const
Sort boxes lexicographically.
Definition CD_ScanShopImplem.H:73
RealVect m_probLo
Lower-left corner of simulation domain.
Definition CD_ScanShop.H:184
ScanShop & operator=(ScanShop &&)=delete
Disallow move assignment.
ScanShop(ScanShop &&)=delete
Disallow move construction.
const BaseIF * m_baseIF
Implicit function used to generate geometries.
Definition CD_ScanShop.H:189
Timer m_timer
Timer for when we use run-time profiling.
Definition CD_ScanShop.H:164
bool isCovered(Box a_box, const RealVect &a_probLo, Real a_dx) const
Check if every point in box is covered.
Definition CD_ScanShopImplem.H:48
GeometryService::InOut InsideOutside(const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_probLo, const Real &a_dx, const DataIndex &a_dit) const override
This method is called by EBSILevel when using distributed data.
Definition CD_ScanShop.cpp:492
ScanShop()=delete
Disallowed default constructor.
std::vector< bool > m_hasThisLevel
Check if level has been scanned. 0 = false, != 0 implies true.
Definition CD_ScanShop.H:220
bool m_hasScanLevel
Check if scan level has been built.
Definition CD_ScanShop.H:194
ScanShop & operator=(const ScanShop &)=delete
Disallow copy assignment.
Vector< ProblemDomain > m_domains
Level domains. Note that index 0 is the finest level.
Definition CD_ScanShop.H:204
void fillGraph(BaseFab< int > &a_regIrregCovered, Vector< IrregNode > &a_nodes, const Box &a_validRegion, const Box &a_ghostRegion, const ProblemDomain &a_domain, const RealVect &a_probLo, const Real &a_dx, const DataIndex &a_di) const override
Override of GeometryShop's fillGraph.
Definition CD_ScanShop.cpp:535
Class which is used for run-time monitoring of events.
Definition CD_Timer.H:32
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38
TracerParticleSolver()
Default constructor.
Definition CD_TracerParticleSolverImplem.H:26