amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait > Class Template Reference

#include <OceanWavesTypes.H>

Inheritance diagram for amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >:

Collaboration diagram for amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >:

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

Private Attributes
CFDSim &	m_sim
	Instance of the CFD simulation environment.
OceanWavesTrait::InfoType	m_info
	Basic information about this ocean waves component in relation to the simulation (usually IBInfo)
OceanWavesTrait::MetaType	m_meta
	Additional data necessary for a given wavem type.

Detailed Description

template<typename OceanWavesTrait>
class amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >

Abstract representation of data holder for specific ocean waves types.

Constructor & Destructor Documentation

OceanWavesDataHolder()

template<typename OceanWavesTrait>

amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::OceanWavesDataHolder ( 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 OceanWavesTrait>

OceanWavesTrait::InfoType & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::info ( )

inline

info() [2/2]

template<typename OceanWavesTrait>

const OceanWavesTrait::InfoType & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::info ( ) const

inline

meta() [1/2]

template<typename OceanWavesTrait>

OceanWavesTrait::MetaType & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::meta ( )

inline

meta() [2/2]

template<typename OceanWavesTrait>

const OceanWavesTrait::MetaType & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::meta ( ) const

inline

sim() [1/2]

template<typename OceanWavesTrait>

CFDSim & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::sim ( )

inline

sim() [2/2]

template<typename OceanWavesTrait>

const CFDSim & amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::sim ( ) const

inline

Member Data Documentation

m_info

template<typename OceanWavesTrait>

OceanWavesTrait::InfoType amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::m_info

private

Basic information about this ocean waves component in relation to the simulation (usually IBInfo)

m_meta

template<typename OceanWavesTrait>

OceanWavesTrait::MetaType amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::m_meta

private

Additional data necessary for a given wavem type.

m_sim

template<typename OceanWavesTrait>

CFDSim& amr_wind::ocean_waves::OceanWavesDataHolder< OceanWavesTrait >::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/ocean_waves/OceanWavesTypes.H