ExternalTurbine Struct Reference

AMR-Wind API: ext_turb::ExternalTurbine Struct Reference

AMR-Wind API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <external_base_types.H>

Inheritance diagram for ext_turb::ExternalTurbine:

[legend]

Collaboration diagram for ext_turb::ExternalTurbine:

[legend]

Public Member Functions
virtual float *	position_at_vel (int dir) const =0
	Data access functions that have to be defined for each type.
virtual float *	solid_velocity (int dir) const =0
virtual float *	fluid_velocity (int dir) const =0
virtual float *	force (int dir) const =0
virtual float *	position_at_force (int dir) const =0
virtual float *	chord_at_force () const =0
virtual float *	orientation () const =0
virtual int	length_fluid_velocity (int dir) const =0
virtual int	length_force (int dir) const =0
virtual int	length_position_at_force (int dir) const =0
virtual int	length_orientation () const =0
virtual int	num_vel_pts_blade () const =0

Public Attributes
std::string	tlabel
	Unique string identifier for this turbine.
int	tid_local
	Local ID for this turbine (provided by external interface)
int	tid_global
	Global ID for this turbine (set by Turbine instance)
int	num_pts_blade
	Number of actuator points per blade.
int	num_pts_tower
	Number of actuator points for tower.
amrex::Array< float, ndim >	base_pos
	Position of tower base in global coordinate system.
amrex::Array< float, 3 >	hub_abs_pos
	Hub stats for Spinner Lidar.
amrex::Array< float, 3 >	hub_rot_vel
amrex::Array< double, 9 >	hub_orient
SimMode	sim_mode {SimMode::init}
std::string	input_file
	External input file.
std::string	checkpoint_file
	Checkpoint file name.
int	num_blades
	Number of blades.
int	num_blade_elem
	Total number of elements along the blade.
int	num_tower_elem
	Total number of elements along the tower.
bool	is_solution0 {true}
double	start_time {0.0}
	Start time for this turbine.
double	stop_time {-1.0}
	End time for this turbine.
double	dt_cfd
	Timestep for CFD.
double	dt_ext
	Timestep for external turbine solver.
int	num_substeps
	Number of sub-steps of external solver per CFD timestep.
int	time_index {0}
	Time step index for external.
int	chkpt_interval
	Checkpoint interval for external.

Static Public Attributes
static constexpr int	ndim = 3

Detailed Description

Representation of a turbine for exchanging data with external solver

Member Function Documentation

◆ chord_at_force()

virtual float * ext_turb::ExternalTurbine::chord_at_force ( ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ fluid_velocity()

virtual float * ext_turb::ExternalTurbine::fluid_velocity ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ force()

virtual float * ext_turb::ExternalTurbine::force ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ length_fluid_velocity()

virtual int ext_turb::ExternalTurbine::length_fluid_velocity ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ length_force()

virtual int ext_turb::ExternalTurbine::length_force ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ length_orientation()

virtual int ext_turb::ExternalTurbine::length_orientation ( ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ length_position_at_force()

virtual int ext_turb::ExternalTurbine::length_position_at_force ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ num_vel_pts_blade()

virtual int ext_turb::ExternalTurbine::num_vel_pts_blade ( ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ orientation()

virtual float * ext_turb::ExternalTurbine::orientation ( ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ position_at_force()

virtual float * ext_turb::ExternalTurbine::position_at_force ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ position_at_vel()

virtual float * ext_turb::ExternalTurbine::position_at_vel ( int dir ) const

pure virtual

Data access functions that have to be defined for each type.

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

◆ solid_velocity()

virtual float * ext_turb::ExternalTurbine::solid_velocity ( int dir ) const

pure virtual

Implemented in ext_turb::FastTurbine, and ext_turb::KynemaTurbine.

Member Data Documentation

◆ base_pos

amrex::Array<float, ndim> ext_turb::ExternalTurbine::base_pos

Position of tower base in global coordinate system.

◆ checkpoint_file

std::string ext_turb::ExternalTurbine::checkpoint_file

Checkpoint file name.

◆ chkpt_interval

int ext_turb::ExternalTurbine::chkpt_interval

Checkpoint interval for external.

◆ dt_cfd

double ext_turb::ExternalTurbine::dt_cfd

Timestep for CFD.

◆ dt_ext

double ext_turb::ExternalTurbine::dt_ext

Timestep for external turbine solver.

◆ hub_abs_pos

amrex::Array<float, 3> ext_turb::ExternalTurbine::hub_abs_pos

Hub stats for Spinner Lidar.

◆ hub_orient

amrex::Array<double, 9> ext_turb::ExternalTurbine::hub_orient

◆ hub_rot_vel

amrex::Array<float, 3> ext_turb::ExternalTurbine::hub_rot_vel

◆ input_file

std::string ext_turb::ExternalTurbine::input_file

External input file.

◆ is_solution0

bool ext_turb::ExternalTurbine::is_solution0 {true}

◆ ndim

int ext_turb::ExternalTurbine::ndim = 3

staticconstexpr

◆ num_blade_elem

int ext_turb::ExternalTurbine::num_blade_elem

Total number of elements along the blade.

◆ num_blades

int ext_turb::ExternalTurbine::num_blades

Number of blades.

◆ num_pts_blade

int ext_turb::ExternalTurbine::num_pts_blade

Number of actuator points per blade.

◆ num_pts_tower

int ext_turb::ExternalTurbine::num_pts_tower

Number of actuator points for tower.

◆ num_substeps

int ext_turb::ExternalTurbine::num_substeps

Number of sub-steps of external solver per CFD timestep.

◆ num_tower_elem

int ext_turb::ExternalTurbine::num_tower_elem

Total number of elements along the tower.

◆ sim_mode

SimMode ext_turb::ExternalTurbine::sim_mode {SimMode::init}

◆ start_time

double ext_turb::ExternalTurbine::start_time {0.0}

Start time for this turbine.

◆ stop_time

double ext_turb::ExternalTurbine::stop_time {-1.0}

End time for this turbine.

◆ tid_global

int ext_turb::ExternalTurbine::tid_global

Global ID for this turbine (set by Turbine instance)

◆ tid_local

int ext_turb::ExternalTurbine::tid_local

Local ID for this turbine (provided by external interface)

◆ time_index

int ext_turb::ExternalTurbine::time_index {0}

Time step index for external.

◆ tlabel

std::string ext_turb::ExternalTurbine::tlabel

Unique string identifier for this turbine.

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

/home/runner/work/amr-wind/amr-wind/amr-wind/wind_energy/actuator/turbine/external/external_base_types.H

ExternalTurbine Struct Reference

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ chord_at_force()

◆ fluid_velocity()

◆ force()

◆ length_fluid_velocity()

◆ length_force()

◆ length_orientation()

◆ length_position_at_force()

◆ num_vel_pts_blade()

◆ orientation()

◆ position_at_force()

◆ position_at_vel()

◆ solid_velocity()

Member Data Documentation

◆ base_pos

◆ checkpoint_file

◆ chkpt_interval

◆ dt_cfd

◆ dt_ext

◆ hub_abs_pos

◆ hub_orient

◆ hub_rot_vel

◆ input_file

◆ is_solution0

◆ ndim

◆ num_blade_elem

◆ num_blades

◆ num_pts_blade

◆ num_pts_tower

◆ num_substeps

◆ num_tower_elem

◆ sim_mode

◆ start_time

◆ stop_time

◆ tid_global

◆ tid_local

◆ time_index

◆ tlabel