amr_wind::averaging::ReAveraging Class Reference

#include <ReAveraging.H>

Inheritance diagram for amr_wind::averaging::ReAveraging:

Collaboration diagram for amr_wind::averaging::ReAveraging:

Public Member Functions
	ReAveraging (CFDSim &, const std::string &avgname, const std::string &fname)
void	operator() (const SimTime &, const amrex::Real, const amrex::Real, const amrex::Real) override
const std::string &	average_field_name () override

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

Static Private Member Functions
static std::string	avg_name (const std::string &fname, const std::string &avgname)
	Generate the averaged field name based on the field name.

Private Attributes
const Field &	m_field
	Fluctuating field.
Field &	m_average
	Reynolds averaged field.

Detailed Description

Reynolds averaging to compute mean field from a given CFD field

Constructor & Destructor Documentation

ReAveraging()

amr_wind::averaging::ReAveraging::ReAveraging	(	CFDSim &	sim,
		const std::string &	avgname,
		const std::string &	fname )

Member Function Documentation

average_field_name()

const std::string & amr_wind::averaging::ReAveraging::average_field_name ( )

override

avg_name()

std::string amr_wind::averaging::ReAveraging::avg_name ( const std::string & fname, const std::string & avgname )

inlinestaticprivate

Generate the averaged field name based on the field name.

identifier()

std::string amr_wind::averaging::ReAveraging::identifier ( )

inlinestatic

operator()()

void amr_wind::averaging::ReAveraging::operator() ( const SimTime & time, const amrex::Real filter_width, const amrex::Real avg_time_interval, const amrex::Real elapsed_time )

override

Update field averaging at a given timestep

Parameters

time	SimTime instance
filter_width	Time-averaging window specified by user
avg_time_interval	Time interval at which averaging is performed
elapsed_time	Time elapsed since averaging was initiated

Member Data Documentation

m_average

Field& amr_wind::averaging::ReAveraging::m_average

private

Reynolds averaged field.

m_field

const Field& amr_wind::averaging::ReAveraging::m_field

private

Fluctuating field.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/averaging/ReAveraging.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/averaging/ReAveraging.cpp