kynema_sgf::actuator::Actuator Class Reference

#include <Actuator.H>

Inheritance diagram for kynema_sgf::actuator::Actuator:

Collaboration diagram for kynema_sgf::actuator::Actuator:

Public Member Functions
	Actuator (CFDSim &)
	~Actuator () override
void	initialize_fields (int, const amrex::Geometry &) override
void	pre_init_actions () override
void	post_init_actions () override
void	post_regrid_actions () override
void	pre_advance_work () override
void	post_advance_work () override
ActuatorModel &	get_act (int index) const
ActuatorModel &	get_act_bylabel (const std::string &actlabel) const
template<typename T>
T *	get_actuator (std::string &key) const

Static Public Member Functions
static std::string	identifier ()

Protected Member Functions
int	num_actuators () const
	Total number of actuator components (e.g., turbines) in the flow field.
virtual void	prepare_outputs ()

Private Member Functions
void	setup_container ()
void	update_positions ()
void	update_velocities ()
void	compute_forces ()
void	compute_source_term ()
void	communicate_turbine_io ()

Private Attributes
CFDSim &	m_sim
Field &	m_act_source
std::vector< std::unique_ptr< ActuatorModel > >	m_actuators
std::unique_ptr< ActuatorContainer >	m_container

Detailed Description

Actuator line/disk modeling for wind turbines.

This class provides an interface to model wind turbines in a wind farm as actuator line/disk source terms.

See also

ActuatorModel, ActuatorContainer

Constructor & Destructor Documentation

Actuator()

kynema_sgf::actuator::Actuator::Actuator ( CFDSim & sim )

explicit

~Actuator()

kynema_sgf::actuator::Actuator::~Actuator ( )

overridedefault

Member Function Documentation

communicate_turbine_io()

void kynema_sgf::actuator::Actuator::communicate_turbine_io ( )

private

compute_forces()

void kynema_sgf::actuator::Actuator::compute_forces ( )

private

Helper method to compute forces on all actuator components

compute_source_term()

void kynema_sgf::actuator::Actuator::compute_source_term ( )

private

get_act()

ActuatorModel & kynema_sgf::actuator::Actuator::get_act ( int index ) const

inlinenodiscard

get_act_bylabel()

ActuatorModel & kynema_sgf::actuator::Actuator::get_act_bylabel ( const std::string & actlabel ) const

nodiscard

get_actuator()

template<typename T>

T * kynema_sgf::actuator::Actuator::get_actuator

(

std::string &

key

)

const

identifier()

std::string kynema_sgf::actuator::Actuator::identifier ( )

inlinestatic

initialize_fields()

void kynema_sgf::actuator::Actuator::initialize_fields ( int , const amrex::Geometry &  )

inlineoverride

num_actuators()

int kynema_sgf::actuator::Actuator::num_actuators ( ) const

inlinenodiscardprotected

Total number of actuator components (e.g., turbines) in the flow field.

post_advance_work()

void kynema_sgf::actuator::Actuator::post_advance_work ( )

override

post_init_actions()

void kynema_sgf::actuator::Actuator::post_init_actions ( )

override

post_regrid_actions()

void kynema_sgf::actuator::Actuator::post_regrid_actions ( )

override

pre_advance_work()

void kynema_sgf::actuator::Actuator::pre_advance_work ( )

override

pre_init_actions()

void kynema_sgf::actuator::Actuator::pre_init_actions ( )

override

prepare_outputs()

void kynema_sgf::actuator::Actuator::prepare_outputs ( )

protectedvirtual

setup_container()

void kynema_sgf::actuator::Actuator::setup_container ( )

private

Set up the container for sampling velocities

Allocates memory and initializes the particles corresponding to actuator nodes for all turbines that influence the current MPI rank. This method is invoked once during initialization and during regrid step.

update_positions()

void kynema_sgf::actuator::Actuator::update_positions ( )

private

Update actuator positions and sample velocities at new locations.

This method loops over all the turbines local to this MPI rank and updates the position vectors. These new locations are provided to the sampling container that samples velocities at these new locations.

See also

Actuator::update_velocities

update_velocities()

void kynema_sgf::actuator::Actuator::update_velocities ( )

private

Provide updated velocities from container to actuator instances

See also

Acuator::update_positions

Member Data Documentation

m_act_source

Field& kynema_sgf::actuator::Actuator::m_act_source

private

m_actuators

std::vector<std::unique_ptr<ActuatorModel> > kynema_sgf::actuator::Actuator::m_actuators

private

m_container

std::unique_ptr<ActuatorContainer> kynema_sgf::actuator::Actuator::m_container

private

m_sim

CFDSim& kynema_sgf::actuator::Actuator::m_sim

private

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/wind_energy/actuator/Actuator.H
• /home/runner/work/kynema-sgf/kynema-sgf/src/wind_energy/actuator/Actuator.cpp