amr_wind::CFDSim Class Reference

#include <CFDSim.H>

Collaboration diagram for amr_wind::CFDSim:

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
void	set_mbc (MultiBlockContainer *mbc)
MultiBlockContainer **	mbc ()
void	set_read_erf (ReadERFFunction fcn)
ReadERFFunction *	get_read_erf ()
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
FieldBoundaryMgr &	field_boundary_manager ()
const FieldBoundaryMgr &	field_boundary_manager () const
FieldBoundaryMgr::TypeVector &	field_boundaries ()
const FieldBoundaryMgr::TypeVector &	field_boundaries () const
transport::TransportModel &	transport_model ()
const transport::TransportModel &	transport_model () 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_transport_model ()
	Instantiate the transport model based on user inputs.
void	create_turbulence_model ()
	Instantiate the turbulence model based on user inputs.
void	init_physics ()
	Instantiate all physics instances based on user inputs.
void	init_field_boundaries ()
	Instantiate all field boundaries 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
FieldBoundaryMgr	m_field_boundary_mgr
std::unique_ptr< transport::TransportModel >	m_transport
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}
MultiBlockContainer *	m_mbc {nullptr}
ReadERFFunction	m_read_erf {nullptr}

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()

amr_wind::CFDSim::CFDSim ( amrex::AmrCore & mesh )

explicit

~CFDSim()

amr_wind::CFDSim::~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_transport_model()

void amr_wind::CFDSim::create_transport_model

(

)

Instantiate the transport model based on user inputs.

create_turbulence_model()

void amr_wind::CFDSim::create_turbulence_model

(

)

Instantiate the turbulence model based on user inputs.

ext_solver_manager() [1/2]

ExtSolverMgr & amr_wind::CFDSim::ext_solver_manager ( )

inline

ext_solver_manager() [2/2]

const ExtSolverMgr & amr_wind::CFDSim::ext_solver_manager ( ) const

inline

field_boundaries() [1/2]

FieldBoundaryMgr::TypeVector & amr_wind::CFDSim::field_boundaries ( )

inline

field_boundaries() [2/2]

const FieldBoundaryMgr::TypeVector & amr_wind::CFDSim::field_boundaries ( ) const

inline

field_boundary_manager() [1/2]

FieldBoundaryMgr & amr_wind::CFDSim::field_boundary_manager ( )

inline

field_boundary_manager() [2/2]

const FieldBoundaryMgr & amr_wind::CFDSim::field_boundary_manager ( ) const

inline

get_read_erf()

ReadERFFunction * amr_wind::CFDSim::get_read_erf ( )

inline

has_mesh_mapping()

bool amr_wind::CFDSim::has_mesh_mapping ( ) const

inline

has_overset()

bool amr_wind::CFDSim::has_overset

(

)

const

helics() [1/2]

HelicsStorage & amr_wind::CFDSim::helics ( )

inline

helics() [2/2]

const HelicsStorage & amr_wind::CFDSim::helics ( ) const

inline

init_field_boundaries()

void amr_wind::CFDSim::init_field_boundaries

(

)

Instantiate all field boundaries based on user inputs.

init_physics()

void amr_wind::CFDSim::init_physics

(

)

Instantiate all physics instances based on user inputs.

io_manager() [1/2]

IOManager & amr_wind::CFDSim::io_manager ( )

inline

io_manager() [2/2]

const IOManager & amr_wind::CFDSim::io_manager ( ) const

inline

is_anelastic()

bool amr_wind::CFDSim::is_anelastic

(

)

const

is_during_overset_advance()

bool amr_wind::CFDSim::is_during_overset_advance ( ) const

inline

mbc()

MultiBlockContainer ** amr_wind::CFDSim::mbc ( )

inline

mesh() [1/2]

amrex::AmrCore & amr_wind::CFDSim::mesh ( )

inline

Return the AMR mesh hierarchy.

mesh() [2/2]

const amrex::AmrCore & amr_wind::CFDSim::mesh ( ) const

inline

mesh_mapping() [1/2]

MeshMap * amr_wind::CFDSim::mesh_mapping ( )

inline

mesh_mapping() [2/2]

const MeshMap * amr_wind::CFDSim::mesh_mapping ( ) const

inline

overset_manager() [1/2]

OversetManager * amr_wind::CFDSim::overset_manager ( )

inline

overset_manager() [2/2]

const OversetManager * amr_wind::CFDSim::overset_manager ( ) const

inline

pde_manager() [1/2]

pde::PDEMgr & amr_wind::CFDSim::pde_manager ( )

inline

pde_manager() [2/2]

const pde::PDEMgr & amr_wind::CFDSim::pde_manager ( ) const

inline

physics() [1/2]

PhysicsMgr::TypeVector & amr_wind::CFDSim::physics ( )

inline

physics() [2/2]

const PhysicsMgr::TypeVector & amr_wind::CFDSim::physics ( ) const

inline

physics_manager() [1/2]

PhysicsMgr & amr_wind::CFDSim::physics_manager ( )

inline

physics_manager() [2/2]

const PhysicsMgr & amr_wind::CFDSim::physics_manager ( ) const

inline

post_manager() [1/2]

PostProcessManager & amr_wind::CFDSim::post_manager ( )

inline

post_manager() [2/2]

const PostProcessManager & amr_wind::CFDSim::post_manager ( ) const

inline

repo() [1/2]

FieldRepo & amr_wind::CFDSim::repo ( )

inline

Return the field repository.

repo() [2/2]

FieldRepo & amr_wind::CFDSim::repo ( ) const

inline

set_during_overset_advance()

void amr_wind::CFDSim::set_during_overset_advance ( const bool flag )

inline

set_mbc()

void amr_wind::CFDSim::set_mbc ( MultiBlockContainer * mbc )

inline

set_read_erf()

void amr_wind::CFDSim::set_read_erf ( ReadERFFunction fcn )

inline

time() [1/2]

SimTime & amr_wind::CFDSim::time ( )

inline

Return simulation time control.

time() [2/2]

const SimTime & amr_wind::CFDSim::time ( ) const

inline

transport_model() [1/2]

transport::TransportModel & amr_wind::CFDSim::transport_model ( )

inline

transport_model() [2/2]

const transport::TransportModel & amr_wind::CFDSim::transport_model ( ) const

inline

turbulence_model() [1/2]

turbulence::TurbulenceModel & amr_wind::CFDSim::turbulence_model ( )

inline

turbulence_model() [2/2]

const turbulence::TurbulenceModel & amr_wind::CFDSim::turbulence_model ( ) const

inline

Member Data Documentation

m_during_overset_advance

bool amr_wind::CFDSim::m_during_overset_advance {false}

private

m_ext_solver_mgr

std::unique_ptr<ExtSolverMgr> amr_wind::CFDSim::m_ext_solver_mgr

private

m_field_boundary_mgr

FieldBoundaryMgr amr_wind::CFDSim::m_field_boundary_mgr

private

m_helics

std::unique_ptr<HelicsStorage> amr_wind::CFDSim::m_helics

private

m_io_mgr

std::unique_ptr<IOManager> amr_wind::CFDSim::m_io_mgr

private

m_mbc

MultiBlockContainer* amr_wind::CFDSim::m_mbc {nullptr}

private

m_mesh

amrex::AmrCore& amr_wind::CFDSim::m_mesh

private

m_mesh_map

std::unique_ptr<MeshMap> amr_wind::CFDSim::m_mesh_map

private

m_mesh_mapping

bool amr_wind::CFDSim::m_mesh_mapping {false}

private

m_overset_mgr

std::unique_ptr<OversetManager> amr_wind::CFDSim::m_overset_mgr

private

m_pde_mgr

pde::PDEMgr amr_wind::CFDSim::m_pde_mgr

private

m_physics_mgr

PhysicsMgr amr_wind::CFDSim::m_physics_mgr

private

m_post_mgr

std::unique_ptr<PostProcessManager> amr_wind::CFDSim::m_post_mgr

private

m_read_erf

ReadERFFunction amr_wind::CFDSim::m_read_erf {nullptr}

private

m_repo

FieldRepo amr_wind::CFDSim::m_repo

mutableprivate

m_time

SimTime amr_wind::CFDSim::m_time

private

m_transport

std::unique_ptr<transport::TransportModel> amr_wind::CFDSim::m_transport

private

m_turbulence

std::unique_ptr<turbulence::TurbulenceModel> amr_wind::CFDSim::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