amr_wind::actuator::ActDataHolder< ActTrait > Class Template Reference

#include <actuator_types.H>

Collaboration diagram for amr_wind::actuator::ActDataHolder< ActTrait >:

Public Member Functions
	ActDataHolder (CFDSim &sim, const std::string &label, const int id)
CFDSim &	sim ()
const CFDSim &	sim () const
ActTrait::InfoType &	info ()
const ActTrait::InfoType &	info () const
ActTrait::GridType &	grid ()
const ActTrait::GridType &	grid () const
ActTrait::MetaType &	meta ()
const ActTrait::MetaType &	meta () const

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

Detailed Description

template<typename ActTrait>
class amr_wind::actuator::ActDataHolder< ActTrait >

Abstract representation of data holder for specific actuator types.

Constructor & Destructor Documentation

ActDataHolder()

template<typename ActTrait >

amr_wind::actuator::ActDataHolder< ActTrait >::ActDataHolder ( 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 actuator component
id	Unique global integer identifier for this actuator component

Member Function Documentation

grid() [1/2]

template<typename ActTrait >

ActTrait::GridType & amr_wind::actuator::ActDataHolder< ActTrait >::grid ( )

inline

grid() [2/2]

template<typename ActTrait >

const ActTrait::GridType & amr_wind::actuator::ActDataHolder< ActTrait >::grid ( ) const

inline

info() [1/2]

template<typename ActTrait >

ActTrait::InfoType & amr_wind::actuator::ActDataHolder< ActTrait >::info ( )

inline

info() [2/2]

template<typename ActTrait >

const ActTrait::InfoType & amr_wind::actuator::ActDataHolder< ActTrait >::info ( ) const

inline

meta() [1/2]

template<typename ActTrait >

ActTrait::MetaType & amr_wind::actuator::ActDataHolder< ActTrait >::meta ( )

inline

meta() [2/2]

template<typename ActTrait >

const ActTrait::MetaType & amr_wind::actuator::ActDataHolder< ActTrait >::meta ( ) const

inline

sim() [1/2]

template<typename ActTrait >

CFDSim & amr_wind::actuator::ActDataHolder< ActTrait >::sim ( )

inline

sim() [2/2]

template<typename ActTrait >

const CFDSim & amr_wind::actuator::ActDataHolder< ActTrait >::sim ( ) const

inline

Member Data Documentation

m_grid

template<typename ActTrait >

ActTrait::GridType amr_wind::actuator::ActDataHolder< ActTrait >::m_grid

private

Nodal data on the actuator grid defined for this component (usually ActGrid)

m_info

template<typename ActTrait >

ActTrait::InfoType amr_wind::actuator::ActDataHolder< ActTrait >::m_info

private

Basic information about this actuator component in relation to the simulation (usually ActInfo)

m_meta

template<typename ActTrait >

ActTrait::MetaType amr_wind::actuator::ActDataHolder< ActTrait >::m_meta

private

Additional data necessary for a given actuator type.

m_sim

template<typename ActTrait >

CFDSim& amr_wind::actuator::ActDataHolder< ActTrait >::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/wind_energy/actuator/actuator_types.H