kynema_sgf::VelPlaneAveraging Class Reference

#include <FieldPlaneAveraging.H>

Inheritance diagram for kynema_sgf::VelPlaneAveraging:

Collaboration diagram for kynema_sgf::VelPlaneAveraging:

Public Member Functions
	VelPlaneAveraging (CFDSim &sim, int axis_in, int max_level)
	~VelPlaneAveraging () override=default
void	operator() () override
template<typename IndexSelector>
void	compute_hvelmag_averages (const IndexSelector &idxOp)
const amrex::Vector< amrex::Real > &	line_hvelmag_average ()
amrex::Real	line_hvelmag_average_interpolated (amrex::Real x) const
amrex::Real	line_su_average_interpolated (amrex::Real x) const
amrex::Real	line_sv_average_interpolated (amrex::Real x) const
Public Member Functions inherited from kynema_sgf::FPlaneAveraging< Field >
	FPlaneAveraging (const Field &field_in, const kynema_sgf::SimTime &time, int axis_in, int max_level, bool compute_deriv=false)
virtual	~FPlaneAveraging ()=default
void	convert_x_to_ind (amrex::Real x, int &ind, amrex::Real &c) const
amrex::Real	line_average_interpolated (amrex::Real x, int comp) const
amrex::Real	line_average_cell (int ind, int comp) const
amrex::Real	line_derivative_interpolated (amrex::Real x, int comp) const
amrex::Real	line_derivative_of_average_cell (int ind, int comp) const
void	output_line_average_ascii (const std::string &filename, int step, amrex::Real time)
void	output_line_average_ascii (int step, amrex::Real time)
void	set_precision (int p)
amrex::Real	dx () const
amrex::Real	xlo () const
int	axis () const
int	level () const
int	ncomp () const
int	ncell_plane () const
int	ncell_line () const
int	last_updated_index () const
const amrex::Vector< amrex::Real > &	line_average () const
const amrex::Vector< amrex::Real > &	line_deriv () const
void	line_average (int comp, amrex::Vector< amrex::Real > &l_vec)
const amrex::Vector< amrex::Real > &	line_centroids () const
const Field &	field () const
void	compute_averages (const IndexSelector &idxOp)
void	compute_line_derivatives ()

Private Attributes
amrex::Vector< amrex::Real >	m_line_hvelmag_average
amrex::Vector< amrex::Real >	m_line_Su_average
amrex::Vector< amrex::Real >	m_line_Sv_average

Additional Inherited Members
Protected Attributes inherited from kynema_sgf::FPlaneAveraging< Field >
int	m_ncomp
amrex::Vector< amrex::Real >	m_line_average
amrex::Vector< amrex::Real >	m_line_deriv
	line storage for the derivative of average field
amrex::Vector< amrex::Real >	m_line_xcentroid
amrex::Real	m_dx
amrex::Real	m_xlo
amrex::Real	m_xhi
int	m_ncell_plane
int	m_ncell_line
int	m_precision
int	m_last_updated_index
const Field &	m_field
const SimTime &	m_time
const int	m_axis
int	m_max_level
const bool	m_comp_deriv

Detailed Description

Specific application of FieldPlaneAveraging to the velocity field

Constructor & Destructor Documentation

VelPlaneAveraging()

kynema_sgf::VelPlaneAveraging::VelPlaneAveraging	(	CFDSim &	sim,
		int	axis_in,
		int	max_level )

~VelPlaneAveraging()

kynema_sgf::VelPlaneAveraging::~VelPlaneAveraging ( )

overridedefault

Member Function Documentation

compute_hvelmag_averages()

template<typename IndexSelector>

void kynema_sgf::VelPlaneAveraging::compute_hvelmag_averages

(

const IndexSelector &

idxOp

)

line storage for the average horizontal velocity magnitude time y-velocity fill line storage with horizontal velocity magnitude averages

line_hvelmag_average()

const amrex::Vector< amrex::Real > & kynema_sgf::VelPlaneAveraging::line_hvelmag_average ( )

inline

return vector containing horizontal velocity magnitude average

line_hvelmag_average_interpolated()

amrex::Real kynema_sgf::VelPlaneAveraging::line_hvelmag_average_interpolated ( amrex::Real x ) const

nodiscard

evaluate line haverage at specific location for horizontal velocity magnitude

line_su_average_interpolated()

amrex::Real kynema_sgf::VelPlaneAveraging::line_su_average_interpolated ( amrex::Real x ) const

nodiscard

evaluate line haverage at specific location for horizontal velocity magnitude times x-velocity

line_sv_average_interpolated()

amrex::Real kynema_sgf::VelPlaneAveraging::line_sv_average_interpolated ( amrex::Real x ) const

nodiscard

evaluate line haverage at specific location for horizontal velocity magnitude times y-velocity

operator()()

void kynema_sgf::VelPlaneAveraging::operator() ( )

overridevirtual

Reimplemented from kynema_sgf::FPlaneAveraging< Field >.

Member Data Documentation

m_line_hvelmag_average

amrex::Vector<amrex::Real> kynema_sgf::VelPlaneAveraging::m_line_hvelmag_average

private

m_line_Su_average

amrex::Vector<amrex::Real> kynema_sgf::VelPlaneAveraging::m_line_Su_average

private

line storage for the average horizontal velocity magnitude

m_line_Sv_average

amrex::Vector<amrex::Real> kynema_sgf::VelPlaneAveraging::m_line_Sv_average

private

line storage for the average horizontal velocity magnitude time x-velocity

---

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

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