amr_wind::ib::IBDataHolder< IBTrait > Class Template Reference

#include <IBTypes.H>

Collaboration diagram for amr_wind::ib::IBDataHolder< IBTrait >:

Public Member Functions
	IBDataHolder (CFDSim &sim, const std::string &label, const int id)
CFDSim &	sim ()
const CFDSim &	sim () const
IBTrait::InfoType &	info ()
const IBTrait::InfoType &	info () const
IBTrait::MetaType &	meta ()
const IBTrait::MetaType &	meta () const

Private Attributes
CFDSim &	m_sim
	Instance of the CFD simulation environment.
IBTrait::InfoType	m_info
IBTrait::MetaType	m_meta
	Additional data necessary for a given actuator type.

Detailed Description

template<typename IBTrait>
class amr_wind::ib::IBDataHolder< IBTrait >

Abstract representation of data holder for specific immersed boundary types.

Constructor & Destructor Documentation

IBDataHolder()

template<typename IBTrait >

amr_wind::ib::IBDataHolder< IBTrait >::IBDataHolder ( CFDSim & sim, const std::string & label, const int id )

inline

Initialize the data structures

Parameters

sim	Instance of the CFD simulation environment
label	Unique string identifier for this immersed boundary component
id	Unique global integer identifier for this immersed boundary component

Member Function Documentation

info() [1/2]

template<typename IBTrait >

IBTrait::InfoType & amr_wind::ib::IBDataHolder< IBTrait >::info ( )

inline

info() [2/2]

template<typename IBTrait >

const IBTrait::InfoType & amr_wind::ib::IBDataHolder< IBTrait >::info ( ) const

inline

meta() [1/2]

template<typename IBTrait >

IBTrait::MetaType & amr_wind::ib::IBDataHolder< IBTrait >::meta ( )

inline

meta() [2/2]

template<typename IBTrait >

const IBTrait::MetaType & amr_wind::ib::IBDataHolder< IBTrait >::meta ( ) const

inline

sim() [1/2]

template<typename IBTrait >

CFDSim & amr_wind::ib::IBDataHolder< IBTrait >::sim ( )

inline

sim() [2/2]

template<typename IBTrait >

const CFDSim & amr_wind::ib::IBDataHolder< IBTrait >::sim ( ) const

inline

Member Data Documentation

m_info

template<typename IBTrait >

IBTrait::InfoType amr_wind::ib::IBDataHolder< IBTrait >::m_info

private

Basic information about this immersed boundary component in relation to the simulation (usually IBInfo)

m_meta

template<typename IBTrait >

IBTrait::MetaType amr_wind::ib::IBDataHolder< IBTrait >::m_meta

private

Additional data necessary for a given actuator type.

m_sim

template<typename IBTrait >

CFDSim& amr_wind::ib::IBDataHolder< IBTrait >::m_sim

private

Instance of the CFD simulation environment.

---

The documentation for this class was generated from the following file:

• /home/runner/work/amr-wind/amr-wind/amr-wind/immersed_boundary/IBTypes.H