amr_wind::averaging::TimeAveraging Class Reference

#include <TimeAveraging.H>

Inheritance diagram for amr_wind::averaging::TimeAveraging:

Collaboration diagram for amr_wind::averaging::TimeAveraging:

Public Member Functions
	TimeAveraging (CFDSim &, std::string)
	~TimeAveraging () override
void	pre_init_actions () override
	Perform actions before mesh is created.
void	initialize () override
void	post_advance_work () override
void	post_regrid_actions () override
const std::string &	add_averaging (const std::string &field_name, const std::string &avg_type="ReAveraging")

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

Private Attributes
CFDSim &	m_sim
const std::string	m_label
amrex::Vector< std::unique_ptr< FieldTimeAverage > >	m_averages
	Vector containing all registered field averagers.
std::map< std::string, FieldTimeAverage * >	m_registered
	Fields registered so far to avoid duplication.
amrex::Real	m_start_time {0.0}
	Time to start averaging the fields.
amrex::Real	m_stop_time {std::numeric_limits<amrex::Real>::max()}
	Time to stop averaging the fields.
amrex::Real	m_filter {0.0}
	Time averaging window (in seconds)

Detailed Description

A collection of time-averaged quantities

Constructor & Destructor Documentation

TimeAveraging()

amr_wind::averaging::TimeAveraging::TimeAveraging	(	CFDSim &	sim,
		std::string	label )

~TimeAveraging()

amr_wind::averaging::TimeAveraging::~TimeAveraging ( )

overridedefault

Member Function Documentation

add_averaging()

const std::string & amr_wind::averaging::TimeAveraging::add_averaging	(	const std::string &	field_name,
		const std::string &	avg_type = "ReAveraging" )

identifier()

static std::string amr_wind::averaging::TimeAveraging::identifier ( )

inlinestatic

initialize()

void amr_wind::averaging::TimeAveraging::initialize ( )

override

post_advance_work()

void amr_wind::averaging::TimeAveraging::post_advance_work ( )

override

post_regrid_actions()

void amr_wind::averaging::TimeAveraging::post_regrid_actions ( )

inlineoverride

pre_init_actions()

void amr_wind::averaging::TimeAveraging::pre_init_actions ( )

override

Perform actions before mesh is created.

Member Data Documentation

m_averages

amrex::Vector<std::unique_ptr<FieldTimeAverage> > amr_wind::averaging::TimeAveraging::m_averages

private

Vector containing all registered field averagers.

m_filter

amrex::Real amr_wind::averaging::TimeAveraging::m_filter {0.0}

private

Time averaging window (in seconds)

m_label

const std::string amr_wind::averaging::TimeAveraging::m_label

private

m_registered

std::map<std::string, FieldTimeAverage*> amr_wind::averaging::TimeAveraging::m_registered

private

Fields registered so far to avoid duplication.

m_sim

CFDSim& amr_wind::averaging::TimeAveraging::m_sim

private

m_start_time

amrex::Real amr_wind::averaging::TimeAveraging::m_start_time {0.0}

private

Time to start averaging the fields.

m_stop_time

amrex::Real amr_wind::averaging::TimeAveraging::m_stop_time {std::numeric_limits<amrex::Real>::max()}

private

Time to stop averaging the fields.

---

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

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