/home/runner/work/amr-wind/amr-wind/amr-wind/ocean_waves/OceanWaves.H Source File

AMR-Wind API: /home/runner/work/amr-wind/amr-wind/amr-wind/ocean_waves/OceanWaves.H Source File
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
OceanWaves.H
Go to the documentation of this file.
1#ifndef OCEAN_WAVES_H
2#define OCEAN_WAVES_H
3
7
12namespace amr_wind {
13
14class Field;
15
16namespace ocean_waves {
17
18class OceanWavesModel;
19
28class OceanWaves : public Physics::Register<OceanWaves>
29{
30public:
31 static std::string identifier() { return "OceanWaves"; }
32
33 explicit OceanWaves(CFDSim& /*sim*/);
34
35 ~OceanWaves() override;
36
37 void
38 initialize_fields(int /*level*/, const amrex::Geometry& /*geom*/) override;
39
40 void pre_init_actions() override;
41
42 void post_init_actions() override;
43
44 void post_regrid_actions() override;
45
46 void pre_advance_work() override;
47
48 void pre_predictor_work() override;
49
50 void post_advance_work() override;
51
52 const OceanWavesBoundary& ow_bndry() const { return *m_ow_bndry; }
53
54protected:
55 virtual void prepare_outputs();
56
57private:
59
61 std::unique_ptr<OceanWavesModel> m_owm;
62
64 std::unique_ptr<OceanWavesBoundary> m_ow_bndry;
65
68
71
74
79};
80
81} // namespace ocean_waves
82} // namespace amr_wind
83
84#endif /* OCEAN_WAVES_H */
Definition CFDSim.H:54
Definition Field.H:116
Definition OceanWavesBoundary.H:19
Definition OceanWaves.H:29
CFDSim & m_sim
Definition OceanWaves.H:58
virtual void prepare_outputs()
Definition OceanWaves.cpp:118
Field & m_ow_levelset
Ocean waves target free surface levelset function.
Definition OceanWaves.H:67
void pre_init_actions() override
Definition OceanWaves.cpp:32
void pre_predictor_work() override
Definition OceanWaves.cpp:99
void pre_advance_work() override
Definition OceanWaves.cpp:88
void post_advance_work() override
Definition OceanWaves.cpp:109
void post_init_actions() override
Definition OceanWaves.cpp:69
Field & m_ow_velocity
Ocean waves target velocity.
Definition OceanWaves.H:73
std::unique_ptr< OceanWavesBoundary > m_ow_bndry
Ocean waves boundary instance.
Definition OceanWaves.H:64
Field & m_ow_vof
Ocean waves target volume-of-fluid.
Definition OceanWaves.H:70
const OceanWavesBoundary & ow_bndry() const
Definition OceanWaves.H:52
void initialize_fields(int, const amrex::Geometry &) override
Definition OceanWaves.cpp:63
bool m_multiphase_mode
Definition OceanWaves.H:78
void post_regrid_actions() override
Definition OceanWaves.cpp:82
OceanWaves(CFDSim &)
Definition OceanWaves.cpp:13
static std::string identifier()
Definition OceanWaves.H:31
std::unique_ptr< OceanWavesModel > m_owm
Unique pointer to the ocean waves model.
Definition OceanWaves.H:61
Definition BCInterface.cpp:7