ReAveraging Class Reference

AMR-Wind API: amr_wind::averaging::ReAveraging Class Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches

#include <ReAveraging.H>

Inheritance diagram for amr_wind::averaging::ReAveraging:
[legend]
Collaboration diagram for amr_wind::averaging::ReAveraging:
[legend]

Public Member Functions

 ReAveraging (CFDSim &, const std::string &fname)
 
void operator() (const SimTime &, 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)
 Generate the averaged field name based on the field name.
 

Private Attributes

const Fieldm_field
 Fluctuating field.
 
Fieldm_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 & fname )

Member Function Documentation

◆ average_field_name()

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

◆ avg_name()

static std::string amr_wind::averaging::ReAveraging::avg_name ( const std::string & fname)
inlinestaticprivate

Generate the averaged field name based on the field name.

◆ identifier()

static 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 elapsed_time )
override

Update field averaging at a given timestep

Parameters
timeSimTime instance
filter_widthTime-averaging window specified by user
elapsed_timeTime 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