ThunderEgg  1.0.0
DomainGenerator.h
Go to the documentation of this file.
1 /***************************************************************************
2  * ThunderEgg, a library for solvers on adaptively refined block-structured
3  * Cartesian grids.
4  *
5  * Copyright (c) 2019-2021 Scott Aiton
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <https://www.gnu.org/licenses/>.
19  ***************************************************************************/
20 
21 #ifndef THUNDEREGG_DOMAINGENERATOR_H
22 #define THUNDEREGG_DOMAINGENERATOR_H
23 
28 #include <ThunderEgg/Domain.h>
29 namespace ThunderEgg {
38 template<int D>
40 {
41 public:
45  virtual ~DomainGenerator(){};
49  virtual Domain<D> getFinestDomain() = 0;
53  virtual bool hasCoarserDomain() = 0;
57  virtual Domain<D> getCoarserDomain() = 0;
58 };
59 } // namespace ThunderEgg
60 #endif
ThunderEgg::DomainGenerator::~DomainGenerator
virtual ~DomainGenerator()
Destroy the DomainGenerator object.
Definition: DomainGenerator.h:45
ThunderEgg::Domain
Uses a collection of PatchInfo objects to represent the domain of the problem.
Definition: Domain.h:50
ThunderEgg
The ThunderEgg namespace.
Definition: BiLinearGhostFiller.h:31
ThunderEgg::DomainGenerator
Generates Domain objects.
Definition: DomainGenerator.h:39
Domain.h
Domain class.
ThunderEgg::DomainGenerator::hasCoarserDomain
virtual bool hasCoarserDomain()=0
return true if there is a coarser domain to be generated.
ThunderEgg::DomainGenerator::getCoarserDomain
virtual Domain< D > getCoarserDomain()=0
Return a new coarser domain.
ThunderEgg::DomainGenerator::getFinestDomain
virtual Domain< D > getFinestDomain()=0
Return the finest domain.