amr_wind::sampling::LidarSampler Class Reference

#include <LidarSampler.H>

Inheritance diagram for amr_wind::sampling::LidarSampler:

Collaboration diagram for amr_wind::sampling::LidarSampler:

Public Member Functions
	LidarSampler (const CFDSim &)
void	initialize (const std::string &key) override
bool	update_sampling_locations () override
void	post_sample_actions () override
std::string	sampletype () const override
	Type of this sampling object.
void	define_netcdf_metadata (const ncutils::NCGroup &) const override
void	populate_netcdf_metadata (const ncutils::NCGroup &) const override
void	output_netcdf_data (const ncutils::NCGroup &, const size_t) const override
Public Member Functions inherited from amr_wind::sampling::LineSampler
	LineSampler (const CFDSim &)
	~LineSampler () override
void	initialize (const std::string &key) override
void	check_bounds () override
	Check and fix the bounds of the sampler so the probes are in the domain.
void	sampling_locations (SampleLocType &) const override
	Populate and return a vector of probe locations to be sampled.
void	sampling_locations (SampleLocType &, const amrex::Box &) const override
	Populate the vector with coordinates of the sampling locations inside a box.
void	output_locations (SampleLocType &sample_locs) const override
void	define_netcdf_metadata (const ncutils::NCGroup &) const override
void	populate_netcdf_metadata (const ncutils::NCGroup &) const override
std::string	label () const override
	Name of this sampling object.
std::string &	label () override
std::string	sampletype () const override
	Type of this sampling object.
int	id () const override
	Unique identifier for this set of probe locations.
int &	id () override
long	num_points () const override
	Number of probe locations along the line.
long	num_output_points () const override
	Number of output probe locations (after data reduction etc.)

Static Public Member Functions
static std::string	identifier ()
Static Public Member Functions inherited from amr_wind::sampling::LineSampler
static std::string	identifier ()

Protected Attributes
amrex::Vector< amrex::Real >	m_origin
amrex::Vector< amrex::Real >	m_time_table
amrex::Vector< amrex::Real >	m_azimuth_table
amrex::Vector< amrex::Real >	m_elevation_table
amrex::Real	m_length {0}
bool	m_periodic {true}
amrex::Real	m_period {std::numeric_limits<amrex::Real>::max()}
Protected Attributes inherited from amr_wind::sampling::LineSampler
const CFDSim &	m_sim
amrex::Vector< amrex::Real >	m_start
amrex::Vector< amrex::Real >	m_end
std::string	m_label
int	m_id {-1}
int	m_npts {0}

Detailed Description

Sample data along a line that moves in time

Defines probes along a line defined by a time history from m_azimuth_table and m_elevation_table with a length of m_length. This determines the start and end points at every time-step and divides the line into equal segments as determined by num_points. The length of each segment is given by

\[ m_length / (num_points - 1) \]

Constructor & Destructor Documentation

LidarSampler()

amr_wind::sampling::LidarSampler::LidarSampler ( const CFDSim & sim )

explicit

Member Function Documentation

define_netcdf_metadata()

void amr_wind::sampling::LidarSampler::define_netcdf_metadata ( const ncutils::NCGroup & grp ) const

override

identifier()

std::string amr_wind::sampling::LidarSampler::identifier ( )

inlinestatic

initialize()

void amr_wind::sampling::LidarSampler::initialize ( const std::string & key )

override

Read user inputs and initialize the sampling object

Parameters

key	Prefix used to parse inputs from file

output_netcdf_data()

void amr_wind::sampling::LidarSampler::output_netcdf_data ( const ncutils::NCGroup & grp, const size_t nt ) const

override

populate_netcdf_metadata()

void amr_wind::sampling::LidarSampler::populate_netcdf_metadata ( const ncutils::NCGroup & ) const

override

post_sample_actions()

void amr_wind::sampling::LidarSampler::post_sample_actions ( )

inlineoverride

sampletype()

std::string amr_wind::sampling::LidarSampler::sampletype ( ) const

inlineoverride

Type of this sampling object.

update_sampling_locations()

bool amr_wind::sampling::LidarSampler::update_sampling_locations ( )

override

Update the position of the sampling locations in time

Member Data Documentation

m_azimuth_table

amrex::Vector<amrex::Real> amr_wind::sampling::LidarSampler::m_azimuth_table

protected

m_elevation_table

amrex::Vector<amrex::Real> amr_wind::sampling::LidarSampler::m_elevation_table

protected

m_length

amrex::Real amr_wind::sampling::LidarSampler::m_length {0}

protected

m_origin

amrex::Vector<amrex::Real> amr_wind::sampling::LidarSampler::m_origin

protected

m_period

amrex::Real amr_wind::sampling::LidarSampler::m_period {std::numeric_limits<amrex::Real>::max()}

protected

m_periodic

bool amr_wind::sampling::LidarSampler::m_periodic {true}

protected

m_time_table

amrex::Vector<amrex::Real> amr_wind::sampling::LidarSampler::m_time_table

protected

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/sampling/LidarSampler.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/sampling/LidarSampler.cpp