CFDSim Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
|
#include <CFDSim.H>
Public Member Functions | |
CFDSim (amrex::AmrCore &mesh) | |
~CFDSim () | |
amrex::AmrCore & | mesh () |
Return the AMR mesh hierarchy. | |
const amrex::AmrCore & | mesh () const |
SimTime & | time () |
Return simulation time control. | |
const SimTime & | time () const |
FieldRepo & | repo () |
Return the field repository. | |
FieldRepo & | repo () const |
pde::PDEMgr & | pde_manager () |
const pde::PDEMgr & | pde_manager () const |
PhysicsMgr & | physics_manager () |
const PhysicsMgr & | physics_manager () const |
PhysicsMgr::TypeVector & | physics () |
const PhysicsMgr::TypeVector & | physics () const |
turbulence::TurbulenceModel & | turbulence_model () |
const turbulence::TurbulenceModel & | turbulence_model () const |
IOManager & | io_manager () |
const IOManager & | io_manager () const |
PostProcessManager & | post_manager () |
const PostProcessManager & | post_manager () const |
OversetManager * | overset_manager () |
const OversetManager * | overset_manager () const |
MeshMap * | mesh_mapping () |
const MeshMap * | mesh_mapping () const |
ExtSolverMgr & | ext_solver_manager () |
const ExtSolverMgr & | ext_solver_manager () const |
HelicsStorage & | helics () |
const HelicsStorage & | helics () const |
bool | has_overset () const |
void | create_turbulence_model () |
Instantiate the turbulence model based on user inputs. | |
void | init_physics () |
Instantiate all physics instances based on user inputs. | |
void | activate_overset () |
Activate overset connectivity. | |
void | activate_mesh_map () |
Activate mesh mapping. | |
bool | has_mesh_mapping () const |
void | set_during_overset_advance (const bool flag) |
bool | is_during_overset_advance () const |
bool | is_anelastic () const |
Private Attributes | |
amrex::AmrCore & | m_mesh |
SimTime | m_time |
FieldRepo | m_repo |
pde::PDEMgr | m_pde_mgr |
PhysicsMgr | m_physics_mgr |
std::unique_ptr< turbulence::TurbulenceModel > | m_turbulence |
std::unique_ptr< IOManager > | m_io_mgr |
std::unique_ptr< PostProcessManager > | m_post_mgr |
std::unique_ptr< OversetManager > | m_overset_mgr |
std::unique_ptr< MeshMap > | m_mesh_map |
std::unique_ptr< ExtSolverMgr > | m_ext_solver_mgr |
std::unique_ptr< HelicsStorage > | m_helics |
bool | m_mesh_mapping {false} |
bool | m_during_overset_advance {false} |
Detailed Description
Data structures for a CFD simulation
CFDSim represents the amr-wind execution environment and manages all the necessary components used to perform a simulation. Each simulation contains a single CFDSim instance that holds references to the mesh, FieldRepo, SimTime, PhysicsMgr, pde::PDEMgr, IOManager, and post-processing manager instances. This class is just a data holder and does not perform any computational logic itself. The computational heavy-lifting is performed by the class instances within a time integration loop.
Constructor & Destructor Documentation
◆ CFDSim()
|
explicit |
◆ ~CFDSim()
|
default |
Member Function Documentation
◆ activate_mesh_map()
void amr_wind::CFDSim::activate_mesh_map | ( | ) |
Activate mesh mapping.
◆ activate_overset()
void amr_wind::CFDSim::activate_overset | ( | ) |
Activate overset connectivity.
◆ create_turbulence_model()
void amr_wind::CFDSim::create_turbulence_model | ( | ) |
Instantiate the turbulence model based on user inputs.
◆ ext_solver_manager() [1/2]
|
inline |
◆ ext_solver_manager() [2/2]
|
inline |
◆ has_mesh_mapping()
|
inline |
◆ has_overset()
bool amr_wind::CFDSim::has_overset | ( | ) | const |
◆ helics() [1/2]
|
inline |
◆ helics() [2/2]
|
inline |
◆ init_physics()
void amr_wind::CFDSim::init_physics | ( | ) |
Instantiate all physics instances based on user inputs.
◆ io_manager() [1/2]
|
inline |
◆ io_manager() [2/2]
|
inline |
◆ is_anelastic()
bool amr_wind::CFDSim::is_anelastic | ( | ) | const |
◆ is_during_overset_advance()
|
inline |
◆ mesh() [1/2]
|
inline |
Return the AMR mesh hierarchy.
◆ mesh() [2/2]
|
inline |
◆ mesh_mapping() [1/2]
|
inline |
◆ mesh_mapping() [2/2]
|
inline |
◆ overset_manager() [1/2]
|
inline |
◆ overset_manager() [2/2]
|
inline |
◆ pde_manager() [1/2]
|
inline |
◆ pde_manager() [2/2]
|
inline |
◆ physics() [1/2]
|
inline |
◆ physics() [2/2]
|
inline |
◆ physics_manager() [1/2]
|
inline |
◆ physics_manager() [2/2]
|
inline |
◆ post_manager() [1/2]
|
inline |
◆ post_manager() [2/2]
|
inline |
◆ repo() [1/2]
|
inline |
Return the field repository.
◆ repo() [2/2]
|
inline |
◆ set_during_overset_advance()
|
inline |
◆ time() [1/2]
|
inline |
Return simulation time control.
◆ time() [2/2]
|
inline |
◆ turbulence_model() [1/2]
|
inline |
◆ turbulence_model() [2/2]
|
inline |
Member Data Documentation
◆ m_during_overset_advance
|
private |
◆ m_ext_solver_mgr
|
private |
◆ m_helics
|
private |
◆ m_io_mgr
|
private |
◆ m_mesh
|
private |
◆ m_mesh_map
|
private |
◆ m_mesh_mapping
|
private |
◆ m_overset_mgr
|
private |
◆ m_pde_mgr
|
private |
◆ m_physics_mgr
|
private |
◆ m_post_mgr
|
private |
◆ m_repo
|
mutableprivate |
◆ m_time
|
private |
◆ m_turbulence
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/amr-wind/amr-wind/amr-wind/CFDSim.H
- /home/runner/work/amr-wind/amr-wind/amr-wind/CFDSim.cpp
Generated by 1.12.0