amr_wind::sampling::LineSampler Class Reference

#include <LineSampler.H>

Inheritance diagram for amr_wind::sampling::LineSampler:

Collaboration diagram for amr_wind::sampling::LineSampler:

Public Member Functions
	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
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 ()

Protected Attributes
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

Defines probes along a line defined by start and end coordinates and divides it into equal segments as determined by num_points. The length of each segment is given by

\[ (end - start) / (num_points - 1) \]

Constructor & Destructor Documentation

LineSampler()

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

explicit

~LineSampler()

amr_wind::sampling::LineSampler::~LineSampler ( )

overridedefault

Member Function Documentation

check_bounds()

void amr_wind::sampling::LineSampler::check_bounds ( )

override

Check and fix the bounds of the sampler so the probes are in the domain.

define_netcdf_metadata()

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

override

id() [1/2]

int amr_wind::sampling::LineSampler::id ( ) const

inlineoverride

Unique identifier for this set of probe locations.

id() [2/2]

int & amr_wind::sampling::LineSampler::id ( )

inlineoverride

identifier()

static std::string amr_wind::sampling::LineSampler::identifier ( )

inlinestatic

initialize()

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

override

Read user inputs and initialize the sampling object

Parameters

key	Prefix used to parse inputs from file

label() [1/2]

std::string amr_wind::sampling::LineSampler::label ( ) const

inlineoverride

Name of this sampling object.

label() [2/2]

std::string & amr_wind::sampling::LineSampler::label ( )

inlineoverride

num_output_points()

long amr_wind::sampling::LineSampler::num_output_points ( ) const

inlineoverride

Number of output probe locations (after data reduction etc.)

num_points()

long amr_wind::sampling::LineSampler::num_points ( ) const

inlineoverride

Number of probe locations along the line.

output_locations()

void amr_wind::sampling::LineSampler::output_locations ( SampleLocType & sample_locs ) const

inlineoverride

populate_netcdf_metadata()

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

override

sampletype()

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

inlineoverride

Type of this sampling object.

sampling_locations() [1/2]

void amr_wind::sampling::LineSampler::sampling_locations ( SampleLocType & sample_locs ) const

override

Populate and return a vector of probe locations to be sampled.

sampling_locations() [2/2]

void amr_wind::sampling::LineSampler::sampling_locations ( SampleLocType & sample_locs, const amrex::Box & box ) const

override

Populate the vector with coordinates of the sampling locations inside a box

Member Data Documentation

m_end

amrex::Vector<amrex::Real> amr_wind::sampling::LineSampler::m_end

protected

m_id

int amr_wind::sampling::LineSampler::m_id {-1}

protected

m_label

std::string amr_wind::sampling::LineSampler::m_label

protected

m_npts

int amr_wind::sampling::LineSampler::m_npts {0}

protected

m_sim

const CFDSim& amr_wind::sampling::LineSampler::m_sim

protected

m_start

amrex::Vector<amrex::Real> amr_wind::sampling::LineSampler::m_start

protected

---

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

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