ExtTurbIface< SolverTurbine, SolverData > Class Template Reference

AMR-Wind API: ext_turb::ExtTurbIface< SolverTurbine, SolverData > Class Template Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches

#include <ExtTurbIface.H>

Inheritance diagram for ext_turb::ExtTurbIface< SolverTurbine, SolverData >:
[legend]
Collaboration diagram for ext_turb::ExtTurbIface< SolverTurbine, SolverData >:
[legend]

Public Member Functions

 ExtTurbIface (const ::amr_wind::CFDSim &sim)
int register_turbine (SolverTurbine &data)
void init_turbine (const int local_id)
void advance_turbine (const int local_id)
int num_local_turbines () const
 ~ExtTurbIface () override
void parse_inputs (const amr_wind::CFDSim &, const std::string &)
void init_solution (const int local_id)
void get_hub_stats (const int local_id)
void do_turbine_step (SolverTurbine &fi)
void write_turbine_checkpoint (int &tid)
 ~ExtTurbIface ()
void parse_inputs (const amr_wind::CFDSim &sim, const std::string &inp_name)
void init_solution (const int local_id)
void get_hub_stats (const int local_id)
void do_turbine_step (FastTurbine &fi)
void write_turbine_checkpoint (int &tid)
 ~ExtTurbIface ()
void parse_inputs (const amr_wind::CFDSim &sim, const std::string &inp_name)
void init_solution (const int local_id)
void get_hub_stats (const int local_id)
void do_turbine_step (KynemaTurbine &fi)
void write_turbine_checkpoint (int &tid)

Static Public Member Functions

static std::string identifier ()

Protected Member Functions

void allocate_ext_turbines ()
void ext_init_turbine (SolverTurbine &)
void ext_restart_turbine (SolverTurbine &)
void ext_replay_turbine (SolverTurbine &)
void prepare_netcdf_file (SolverTurbine &)
void write_velocity_data (const SolverTurbine &)
void allocate_ext_turbines ()
void prepare_netcdf_file (FastTurbine &)
void write_velocity_data (const FastTurbine &)
void read_velocity_data (FastTurbine &, const ncutils::NCFile &, const size_t)
void ext_init_turbine (FastTurbine &fi)
void ext_replay_turbine (FastTurbine &fi)
void ext_restart_turbine (FastTurbine &fi)
void allocate_ext_turbines ()
void prepare_netcdf_file (KynemaTurbine &)
void write_velocity_data (const KynemaTurbine &)
void read_velocity_data (KynemaTurbine &, const ncutils::NCFile &, const size_t)
void ext_init_turbine (KynemaTurbine &fi)
void ext_replay_turbine (KynemaTurbine &fi)
void ext_restart_turbine (KynemaTurbine &fi)

Static Protected Member Functions

static void read_velocity_data (SolverTurbine &, const ncutils::NCFile &, const size_t tid)

Protected Attributes

std::map< int, int > m_turbine_map
 Global to local index lookup map.
std::vector< SolverTurbine * > m_turbine_data
double m_dt_cfd {0.0}
double m_start_time {0.0}
double m_stop_time {-1.0}
::ext_turb::SimMode m_sim_mode {::ext_turb::SimMode::init}
SolverData m_solver_data
bool m_is_initialized {false}

Constructor & Destructor Documentation

◆ ExtTurbIface()

template<typename SolverTurbine, typename SolverData>
ext_turb::ExtTurbIface< SolverTurbine, SolverData >::ExtTurbIface ( const ::amr_wind::CFDSim & sim)
explicit

◆ ~ExtTurbIface() [1/3]

template<typename SolverTurbine, typename SolverData>
ext_turb::ExtTurbIface< SolverTurbine, SolverData >::~ExtTurbIface ( )
override

◆ ~ExtTurbIface() [2/3]

◆ ~ExtTurbIface() [3/3]

Member Function Documentation

◆ advance_turbine()

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::advance_turbine ( const int local_id)

◆ allocate_ext_turbines() [1/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::allocate_ext_turbines ( )
protected

◆ allocate_ext_turbines() [2/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::allocate_ext_turbines ( )
protected

◆ allocate_ext_turbines() [3/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::allocate_ext_turbines ( )
protected

◆ do_turbine_step() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::do_turbine_step ( FastTurbine & fi)

◆ do_turbine_step() [2/3]

◆ do_turbine_step() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::do_turbine_step ( SolverTurbine & fi)

◆ ext_init_turbine() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::ext_init_turbine ( FastTurbine & fi)
protected

◆ ext_init_turbine() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::ext_init_turbine ( KynemaTurbine & fi)
protected

◆ ext_init_turbine() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::ext_init_turbine ( SolverTurbine & )
protected

◆ ext_replay_turbine() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::ext_replay_turbine ( FastTurbine & fi)
protected

◆ ext_replay_turbine() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::ext_replay_turbine ( KynemaTurbine & fi)
protected

◆ ext_replay_turbine() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::ext_replay_turbine ( SolverTurbine & )
protected

◆ ext_restart_turbine() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::ext_restart_turbine ( FastTurbine & fi)
protected

◆ ext_restart_turbine() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::ext_restart_turbine ( KynemaTurbine & fi)
protected

◆ ext_restart_turbine() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::ext_restart_turbine ( SolverTurbine & )
protected

◆ get_hub_stats() [1/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::get_hub_stats ( const int local_id)

◆ get_hub_stats() [2/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::get_hub_stats ( const int local_id)

◆ get_hub_stats() [3/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::get_hub_stats ( const int local_id)

◆ identifier()

template<typename SolverTurbine, typename SolverData>
std::string ext_turb::ExtTurbIface< SolverTurbine, SolverData >::identifier ( )
inlinestatic

◆ init_solution() [1/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::init_solution ( const int local_id)

◆ init_solution() [2/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::init_solution ( const int local_id)

◆ init_solution() [3/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::init_solution ( const int local_id)

◆ init_turbine()

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::init_turbine ( const int local_id)

◆ num_local_turbines()

template<typename SolverTurbine, typename SolverData>
int ext_turb::ExtTurbIface< SolverTurbine, SolverData >::num_local_turbines ( ) const
inline

◆ parse_inputs() [1/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::parse_inputs ( const amr_wind::CFDSim & ,
const std::string &  )

◆ parse_inputs() [2/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::parse_inputs ( const amr_wind::CFDSim & sim,
const std::string & inp_name )

◆ parse_inputs() [3/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::parse_inputs ( const amr_wind::CFDSim & sim,
const std::string & inp_name )

◆ prepare_netcdf_file() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::prepare_netcdf_file ( FastTurbine & )
protected

◆ prepare_netcdf_file() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::prepare_netcdf_file ( KynemaTurbine & )
protected

◆ prepare_netcdf_file() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::prepare_netcdf_file ( SolverTurbine & )
protected

◆ read_velocity_data() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::read_velocity_data ( FastTurbine & ,
const ncutils::NCFile & ,
const size_t  )
protected

◆ read_velocity_data() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::read_velocity_data ( KynemaTurbine & ,
const ncutils::NCFile & ,
const size_t  )
protected

◆ read_velocity_data() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::read_velocity_data ( SolverTurbine & ,
const ncutils::NCFile & ,
const size_t tid )
staticprotected

◆ register_turbine()

template<typename SolverTurbine, typename SolverData>
int ext_turb::ExtTurbIface< SolverTurbine, SolverData >::register_turbine ( SolverTurbine & data)

◆ write_turbine_checkpoint() [1/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::write_turbine_checkpoint ( int & tid)

◆ write_turbine_checkpoint() [2/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::write_turbine_checkpoint ( int & tid)

◆ write_turbine_checkpoint() [3/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::write_turbine_checkpoint ( int & tid)

◆ write_velocity_data() [1/3]

void ext_turb::ExtTurbIface< FastTurbine, FastSolverData >::write_velocity_data ( const FastTurbine & )
protected

◆ write_velocity_data() [2/3]

void ext_turb::ExtTurbIface< KynemaTurbine, KynemaSolverData >::write_velocity_data ( const KynemaTurbine & )
protected

◆ write_velocity_data() [3/3]

template<typename SolverTurbine, typename SolverData>
void ext_turb::ExtTurbIface< SolverTurbine, SolverData >::write_velocity_data ( const SolverTurbine & )
protected

Member Data Documentation

◆ m_dt_cfd

template<typename SolverTurbine, typename SolverData>
double ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_dt_cfd {0.0}
protected

◆ m_is_initialized

template<typename SolverTurbine, typename SolverData>
bool ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_is_initialized {false}
protected

◆ m_sim_mode

template<typename SolverTurbine, typename SolverData>
::ext_turb::SimMode ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_sim_mode {::ext_turb::SimMode::init}
protected

◆ m_solver_data

template<typename SolverTurbine, typename SolverData>
SolverData ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_solver_data
protected

◆ m_start_time

template<typename SolverTurbine, typename SolverData>
double ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_start_time {0.0}
protected

◆ m_stop_time

template<typename SolverTurbine, typename SolverData>
double ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_stop_time {-1.0}
protected

◆ m_turbine_data

template<typename SolverTurbine, typename SolverData>
std::vector<SolverTurbine*> ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_turbine_data
protected

◆ m_turbine_map

template<typename SolverTurbine, typename SolverData>
std::map<int, int> ext_turb::ExtTurbIface< SolverTurbine, SolverData >::m_turbine_map
protected

Global to local index lookup map.


The documentation for this class was generated from the following file:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/wind_energy/actuator/turbine/external/ExtTurbIface.H