amr_wind::sampling::ProbeSampler Class Reference

#include <ProbeSampler.H>

Inheritance diagram for amr_wind::sampling::ProbeSampler:

Collaboration diagram for amr_wind::sampling::ProbeSampler:

Public Member Functions
std::string	sampletype () const override
	Type of this sampling object.
	ProbeSampler (const CFDSim &)
	~ProbeSampler () 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 the vector with coordinates of the sampling locations.
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
std::string	label () const override
std::string &	label () override
int	id () const override
int &	id () override
long	num_points () const override
long	num_output_points () const override
	Number of output probe locations (after data reduction etc.)

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

Private Attributes
const CFDSim &	m_sim
SampleLocType	m_probes
amrex::Vector< amrex::Real >	m_offset_vector {0.0, 0.0, 0.0}
amrex::Vector< amrex::Real >	m_poffsets
std::string	m_label
int	m_id {-1}
int	m_npts {0}

Detailed Description

Sample data on a cloud of points

Reads a cloud of point locations from a text file and samples data on those points.

Constructor & Destructor Documentation

ProbeSampler()

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

explicit

~ProbeSampler()

amr_wind::sampling::ProbeSampler::~ProbeSampler ( )

overridedefault

Member Function Documentation

check_bounds()

void amr_wind::sampling::ProbeSampler::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::ProbeSampler::define_netcdf_metadata ( const ncutils::NCGroup & grp ) const

override

id() [1/2]

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

inlineoverride

id() [2/2]

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

inlineoverride

identifier()

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

inlinestatic

initialize()

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

override

label() [1/2]

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

inlineoverride

label() [2/2]

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

inlineoverride

num_output_points()

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

inlineoverride

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

num_points()

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

inlineoverride

output_locations()

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

inlineoverride

sampletype()

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

inlineoverride

Type of this sampling object.

sampling_locations() [1/2]

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

override

Populate the vector with coordinates of the sampling locations.

sampling_locations() [2/2]

void amr_wind::sampling::ProbeSampler::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_id

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

private

m_label

std::string amr_wind::sampling::ProbeSampler::m_label

private

m_npts

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

private

m_offset_vector

amrex::Vector<amrex::Real> amr_wind::sampling::ProbeSampler::m_offset_vector {0.0, 0.0, 0.0}

private

m_poffsets

amrex::Vector<amrex::Real> amr_wind::sampling::ProbeSampler::m_poffsets

private

m_probes

SampleLocType amr_wind::sampling::ProbeSampler::m_probes

private

m_sim

const CFDSim& amr_wind::sampling::ProbeSampler::m_sim

private

---

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

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