amr_wind::averaging::FieldTimeAverage Class Reference

#include <TimeAveraging.H>

Inheritance diagram for amr_wind::averaging::FieldTimeAverage:

Collaboration diagram for amr_wind::averaging::FieldTimeAverage:

Public Member Functions
	~FieldTimeAverage () override=default
virtual void	operator() (const SimTime &time, const amrex::Real filter_width, const amrex::Real avg_time_interval, const amrex::Real elapsed_time)=0
virtual const std::string &	average_field_name ()=0
Public Member Functions inherited from amr_wind::Factory< FieldTimeAverage, CFDSim &, const std::string &, const std::string & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from amr_wind::Factory< FieldTimeAverage, CFDSim &, const std::string &, const std::string & >
static std::unique_ptr< FieldTimeAverage >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Additional Inherited Members
Public Attributes inherited from amr_wind::Factory< FieldTimeAverage, CFDSim &, const std::string &, const std::string & >
friend	Base

Detailed Description

Abstract class for time-averaging of CFD fields.

Constructor & Destructor Documentation

~FieldTimeAverage()

amr_wind::averaging::FieldTimeAverage::~FieldTimeAverage ( )

overridedefault

Member Function Documentation

average_field_name()

virtual const std::string & amr_wind::averaging::FieldTimeAverage::average_field_name ( )

pure virtual

base_identifier()

std::string amr_wind::averaging::FieldTimeAverage::base_identifier ( )

inlinestatic

operator()()

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

pure virtual

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

---

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

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