amr_wind::actuator::ActuatorModel Class Reference

#include <ActuatorModel.H>

Inheritance diagram for amr_wind::actuator::ActuatorModel:

Collaboration diagram for amr_wind::actuator::ActuatorModel:

Public Member Functions
	~ActuatorModel () override=default
virtual const std::string &	label () const =0
virtual int	id () const =0
virtual const ActInfo &	info () const =0
virtual ActInfo &	info ()=0
virtual void	read_inputs (const utils::ActParser &)=0
virtual void	determine_influenced_procs ()=0
virtual void	determine_root_proc (amrex::Vector< int > &)=0
virtual void	init_actuator_source ()=0
virtual int	num_velocity_points () const =0
virtual void	update_positions (VecSlice &)=0
virtual void	update_fields (const VecSlice &, const RealSlice &)=0
virtual void	compute_forces ()=0
virtual void	compute_source_term (const int lev, const amrex::MFIter &mfi, const amrex::Geometry &geom)=0
virtual void	prepare_outputs (const std::string &)=0
virtual void	write_outputs ()=0
Public Member Functions inherited from amr_wind::Factory< ActuatorModel, CFDSim &, const std::string &, const int >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from amr_wind::Factory< ActuatorModel, CFDSim &, const std::string &, const int >
static std::unique_ptr< ActuatorModel >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Additional Inherited Members
Public Attributes inherited from amr_wind::Factory< ActuatorModel, CFDSim &, const std::string &, const int >
friend	Base

Detailed Description

Abstract representation of an actuator source in the flow field.

This class is intended to represent a single object (e.g., turbine, fixed wing) that exists in the computational domain. A collection of source objects (e.g., turbines in a wind farm) is modeled using the amr_wind::Actuator physics class that holds a collection of instances of ActuatorModel and acts on them.

Constructor & Destructor Documentation

~ActuatorModel()

amr_wind::actuator::ActuatorModel::~ActuatorModel ( )

overridedefault

Member Function Documentation

base_identifier()

static std::string amr_wind::actuator::ActuatorModel::base_identifier ( )

inlinestatic

compute_forces()

virtual void amr_wind::actuator::ActuatorModel::compute_forces ( )

pure virtual

compute_source_term()

virtual void amr_wind::actuator::ActuatorModel::compute_source_term ( const int lev, const amrex::MFIter & mfi, const amrex::Geometry & geom )

pure virtual

determine_influenced_procs()

virtual void amr_wind::actuator::ActuatorModel::determine_influenced_procs ( )

pure virtual

determine_root_proc()

virtual void amr_wind::actuator::ActuatorModel::determine_root_proc ( amrex::Vector< int > & )

pure virtual

id()

virtual int amr_wind::actuator::ActuatorModel::id ( ) const

pure virtual

info() [1/2]

virtual const ActInfo & amr_wind::actuator::ActuatorModel::info ( ) const

pure virtual

info() [2/2]

virtual ActInfo & amr_wind::actuator::ActuatorModel::info ( )

pure virtual

init_actuator_source()

virtual void amr_wind::actuator::ActuatorModel::init_actuator_source ( )

pure virtual

label()

virtual const std::string & amr_wind::actuator::ActuatorModel::label ( ) const

pure virtual

num_velocity_points()

virtual int amr_wind::actuator::ActuatorModel::num_velocity_points ( ) const

pure virtual

prepare_outputs()

virtual void amr_wind::actuator::ActuatorModel::prepare_outputs ( const std::string & )

pure virtual

read_inputs()

virtual void amr_wind::actuator::ActuatorModel::read_inputs ( const utils::ActParser & )

pure virtual

update_fields()

virtual void amr_wind::actuator::ActuatorModel::update_fields ( const VecSlice & , const RealSlice &  )

pure virtual

update_positions()

virtual void amr_wind::actuator::ActuatorModel::update_positions ( VecSlice & )

pure virtual

write_outputs()

virtual void amr_wind::actuator::ActuatorModel::write_outputs ( )

pure virtual

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/wind_energy/actuator/ActuatorModel.H