VelPlaneAveraging Class Reference

AMR-Wind API: amr_wind::VelPlaneAveraging Class Reference

AMR-Wind API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <FieldPlaneAveraging.H>

Inheritance diagram for amr_wind::VelPlaneAveraging:

[legend]

Collaboration diagram for amr_wind::VelPlaneAveraging:

[legend]

Public Member Functions
	VelPlaneAveraging (CFDSim &sim, int axis_in)
	~VelPlaneAveraging () override=default
void	operator() () override
template<typename IndexSelector>
void	compute_hvelmag_averages (const IndexSelector &idx_op, const int h1_idx, const int h2_idx, const amrex::MultiFab &mfab)
const amrex::Vector< amrex::Real > &	line_hvelmag_average ()
amrex::Real	line_hvelmag_average_interpolated (amrex::Real x) const
amrex::Real	line_hvelmag_average_cell (int ind) const
void	compute_line_hvelmag_derivatives ()
amrex::Real	line_hvelmag_derivative_interpolated (amrex::Real x) const
amrex::Real	line_hvelmag_derivative_of_average_cell (int ind) 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)
Public Member Functions inherited from amr_wind::FPlaneAveraging< Field >
	FPlaneAveraging (const Field &field_in, const amr_wind::SimTime &time, int axis_in, bool compute_deriv=false)
virtual	~FPlaneAveraging ()=default
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, const amrex::MultiFab &mfab)
void	compute_line_derivatives ()

Private Attributes
amrex::Vector< amrex::Real >	m_line_hvelmag_average
amrex::Vector< amrex::Real >	m_line_hvelmag_deriv
	line storage for the derivative of average horizontal velocity magnitude

Additional Inherited Members
Protected Attributes inherited from amr_wind::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
int	m_ncell_plane
int	m_ncell_line
int	m_precision
const int	m_level
int	m_last_updated_index
const Field &	m_field
const SimTime &	m_time
const int	m_axis
const bool	m_comp_deriv

Detailed Description

Specific application of FieldPlaneAveraging to the velocity field

Constructor & Destructor Documentation

◆ VelPlaneAveraging()

amr_wind::VelPlaneAveraging::VelPlaneAveraging	(	CFDSim &	sim,
		int	axis_in )

◆ ~VelPlaneAveraging()

amr_wind::VelPlaneAveraging::~VelPlaneAveraging ( )

overridedefault

Member Function Documentation

◆ compute_hvelmag_averages()

template<typename IndexSelector>

void amr_wind::VelPlaneAveraging::compute_hvelmag_averages	(	const IndexSelector &	idx_op,
		const int	h1_idx,
		const int	h2_idx,
		const amrex::MultiFab &	mfab )

fill line storage with horizontal velocity magnitude averages

◆ compute_line_hvelmag_derivatives()

void amr_wind::VelPlaneAveraging::compute_line_hvelmag_derivatives ( )

compute derivatives of horizontal velocity magnitude

◆ line_hvelmag_average()

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

inline

return vector containing horizontal velocity magnitude average

◆ line_hvelmag_average_cell()

amrex::Real amr_wind::VelPlaneAveraging::line_hvelmag_average_cell ( int ind ) const

evaluate line average at specific cell for horizontal velocity magnitude

◆ line_hvelmag_average_interpolated()

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

evaluate line haverage at specific location for horizontal velocity magnitude

◆ line_hvelmag_derivative_interpolated()

amrex::Real amr_wind::VelPlaneAveraging::line_hvelmag_derivative_interpolated ( amrex::Real x ) const

evaluate line average derivative at specific location for horizontal velocity magnitude

◆ line_hvelmag_derivative_of_average_cell()

amrex::Real amr_wind::VelPlaneAveraging::line_hvelmag_derivative_of_average_cell ( int ind ) const

evaluate derivative of a line average at specific cell horizontal velocity magnitude

◆ operator()()

void amr_wind::VelPlaneAveraging::operator() ( )

overridevirtual

Reimplemented from amr_wind::FPlaneAveraging< Field >.

◆ output_line_average_ascii() [1/2]

void amr_wind::VelPlaneAveraging::output_line_average_ascii	(	const std::string &	filename,
		int	step,
		amrex::Real	time )

◆ output_line_average_ascii() [2/2]

void amr_wind::VelPlaneAveraging::output_line_average_ascii	(	int	step,
		amrex::Real	time )

Member Data Documentation

◆ m_line_hvelmag_average

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

private

◆ m_line_hvelmag_deriv

amrex::Vector<amrex::Real> amr_wind::VelPlaneAveraging::m_line_hvelmag_deriv