kynema_sgf::sampling::MovingPlaneSampler Class Reference

#include <MovingPlaneSampler.H>

Inheritance diagram for kynema_sgf::sampling::MovingPlaneSampler:

Collaboration diagram for kynema_sgf::sampling::MovingPlaneSampler:

Classes
struct	PlaneGeometry

Public Member Functions
	MovingPlaneSampler (const CFDSim &sim)
void	initialize (const std::string &key) override
void	check_bounds () override
bool	update_sampling_locations () override
std::string	sampletype () const override
void	define_netcdf_metadata (const ncutils::NCGroup &grp) const override
void	output_netcdf_data (const ncutils::NCGroup &grp, size_t nt) const override
void	populate_info_file (std::ostream &fh) const override
Public Member Functions inherited from kynema_sgf::sampling::PlaneSampler
	PlaneSampler (const CFDSim &)
	~PlaneSampler () 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
void	populate_info_file (std::ostream &fh) 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 kynema_sgf::sampling::PlaneSampler
static std::string	identifier ()

Private Member Functions
bool	update_geometry (amrex::Real time)

Private Attributes
PlaneGeometry	m_reference
const ::kynema_sgf::actuator::ActuatorModel *	m_actuator {nullptr}
std::string	m_actuator_label
bool	m_defer_bounds_check {true}

Additional Inherited Members
Protected Attributes inherited from kynema_sgf::sampling::PlaneSampler
const CFDSim &	m_sim
amrex::Vector< amrex::Real >	m_axis1
amrex::Vector< amrex::Real >	m_axis2
amrex::Vector< amrex::Real >	m_origin
amrex::Vector< amrex::Real >	m_offset_vector {0.0_rt, 0.0_rt, 0.0_rt}
amrex::Vector< amrex::Real >	m_poffsets
amrex::Vector< int >	m_npts_dir
std::string	m_label
int	m_id {-1}
int	m_npts {0}
bool	m_snap_to_cell_center {false}

Detailed Description

Plane sampler expressed in and moving with an actuator reference frame.

Constructor & Destructor Documentation

MovingPlaneSampler()

kynema_sgf::sampling::MovingPlaneSampler::MovingPlaneSampler ( const CFDSim & sim )

explicit

Member Function Documentation

check_bounds()

void kynema_sgf::sampling::MovingPlaneSampler::check_bounds ( )

override

define_netcdf_metadata()

void kynema_sgf::sampling::MovingPlaneSampler::define_netcdf_metadata ( const ncutils::NCGroup & grp ) const

override

identifier()

std::string kynema_sgf::sampling::MovingPlaneSampler::identifier ( )

inlinestatic

initialize()

void kynema_sgf::sampling::MovingPlaneSampler::initialize ( const std::string & key )

override

output_netcdf_data()

void kynema_sgf::sampling::MovingPlaneSampler::output_netcdf_data ( const ncutils::NCGroup & grp, size_t nt ) const

override

populate_info_file()

void kynema_sgf::sampling::MovingPlaneSampler::populate_info_file ( std::ostream & fh ) const

override

sampletype()

std::string kynema_sgf::sampling::MovingPlaneSampler::sampletype ( ) const

inlinenodiscardoverride

update_geometry()

bool kynema_sgf::sampling::MovingPlaneSampler::update_geometry ( amrex::Real time )

private

update_sampling_locations()

bool kynema_sgf::sampling::MovingPlaneSampler::update_sampling_locations ( )

override

Member Data Documentation

m_actuator

const ::kynema_sgf::actuator::ActuatorModel* kynema_sgf::sampling::MovingPlaneSampler::m_actuator {nullptr}

private

m_actuator_label

std::string kynema_sgf::sampling::MovingPlaneSampler::m_actuator_label

private

m_defer_bounds_check

bool kynema_sgf::sampling::MovingPlaneSampler::m_defer_bounds_check {true}

private

m_reference

PlaneGeometry kynema_sgf::sampling::MovingPlaneSampler::m_reference

private

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/utilities/sampling/MovingPlaneSampler.H
• /home/runner/work/kynema-sgf/kynema-sgf/src/utilities/sampling/MovingPlaneSampler.cpp