/home/runner/work/amr-wind/amr-wind/amr-wind/utilities/subvolume/SubvolumeBase.H Source File

AMR-Wind API: /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/subvolume/SubvolumeBase.H Source File
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
SubvolumeBase.H
Go to the documentation of this file.
1#ifndef SUBVOLUMEBASE_H
2#define SUBVOLUMEBASE_H
3
4#include <AMReX_RealVect.H>
6
7namespace amr_wind {
8
9class CFDSim;
10
11namespace subvolume {
12
20class SubvolumeBase : public Factory<SubvolumeBase, CFDSim&>
21{
22public:
23 static std::string base_identifier() { return "SubvolumeBase"; }
24
25 ~SubvolumeBase() override = default;
26
28 [[nodiscard]] virtual std::string label() const = 0;
29 virtual std::string& label() = 0;
30
32 [[nodiscard]] virtual std::string subvolumetype() const = 0;
33
35 virtual void initialize(const std::string& key) = 0;
36
38 virtual void evaluate_inputs() = 0;
39
41 virtual void post_init_actions() { evaluate_inputs(); }
42
45
47 [[nodiscard]] virtual int lev() const { return 0; }
48
50 [[nodiscard]] virtual amrex::BoxArray box_array() const
51 {
52 return amrex::BoxArray(0);
53 }
54};
55
56} // namespace subvolume
57} // namespace amr_wind
58
59#endif /* SUBVOLUMEBASE_H */
Definition CFDSim.H:54
Definition SubvolumeBase.H:21
virtual int lev() const
Level that the subvolume corresponds to.
Definition SubvolumeBase.H:47
virtual std::string label() const =0
Name used to refer to this sampler (e.g., myline1)
virtual void post_regrid_actions()
Run actions after regrid.
Definition SubvolumeBase.H:44
virtual std::string & label()=0
static std::string base_identifier()
Definition SubvolumeBase.H:23
virtual void post_init_actions()
Run actions after initialize.
Definition SubvolumeBase.H:41
virtual std::string subvolumetype() const =0
Class name of this sampler (e.g., Rectangular)
virtual amrex::BoxArray box_array() const
BoxArray that the subvolume corresponds to.
Definition SubvolumeBase.H:50
virtual void evaluate_inputs()=0
Check inputs and prepare for output.
virtual void initialize(const std::string &key)=0
Read inputs.
Definition RectangularSubvolume.cpp:7
This test case is intended as an evaluation of the momentum advection scheme.
Definition BCInterface.cpp:10