ActInfo Struct Reference

AMR-Wind API: amr_wind::actuator::ActInfo Struct Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches

#include <actuator_types.H>

Inheritance diagram for amr_wind::actuator::ActInfo:
[legend]
Collaboration diagram for amr_wind::actuator::ActInfo:
[legend]

Public Member Functions

 ActInfo (std::string label_in, const int id_in)
 

Public Attributes

std::string label
 Unique string identifier for the actuator body (wing, turbine)
 
std::set< int > procs
 Set of MPI ranks where this actuator source is active.
 
amrex::RealBox bound_box
 
int id {-1}
 Unique integer identifier for the turbine.
 
int root_proc {-1}
 Root process where this turbine is active.
 
bool is_root_proc {false}
 Flag indicating whether this is root proc.
 
bool actuator_in_proc {false}
 
bool sample_vel_in_proc {false}
 

Detailed Description

Basic information that is common to all actuator types.

Constructor & Destructor Documentation

◆ ActInfo()

amr_wind::actuator::ActInfo::ActInfo ( std::string label_in,
const int id_in )
inline

Member Data Documentation

◆ actuator_in_proc

bool amr_wind::actuator::ActInfo::actuator_in_proc {false}

Flag indicating whether this actuator component is active in the current MPI rank

◆ bound_box

amrex::RealBox amr_wind::actuator::ActInfo::bound_box

Bounding box used to determine processes where this turbine has influence

◆ id

int amr_wind::actuator::ActInfo::id {-1}

Unique integer identifier for the turbine.

◆ is_root_proc

bool amr_wind::actuator::ActInfo::is_root_proc {false}

Flag indicating whether this is root proc.

◆ label

std::string amr_wind::actuator::ActInfo::label

Unique string identifier for the actuator body (wing, turbine)

◆ procs

std::set<int> amr_wind::actuator::ActInfo::procs

Set of MPI ranks where this actuator source is active.

◆ root_proc

int amr_wind::actuator::ActInfo::root_proc {-1}

Root process where this turbine is active.

◆ sample_vel_in_proc

bool amr_wind::actuator::ActInfo::sample_vel_in_proc {false}

Flag indicating whether this process requires velocities sampled at actuator point


The documentation for this struct was generated from the following file:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/wind_energy/actuator/actuator_types.H