amr_wind::PostProcessBase Class Reference

#include <PostProcessing.H>

Inheritance diagram for amr_wind::PostProcessBase:

Collaboration diagram for amr_wind::PostProcessBase:

Public Member Functions
	~PostProcessBase () override=default
virtual void	pre_init_actions ()=0
virtual void	initialize ()=0
virtual void	post_advance_work ()=0
virtual void	output_actions ()=0
virtual void	post_regrid_actions ()=0
	Actions to perform post regrid.
void	populate_output_parameters (amrex::ParmParse &pp)
bool	do_output_now (const int ntime, const amrex::Real time, const amrex::Real dt, amrex::Real tol) const
	Determine if output will happen this time step.
amrex::Real	output_time_interval () const
amrex::Real	output_time_delay () const
amrex::Real	enforce_dt_tolerance () const
bool	enforce_dt () const
Public Member Functions inherited from amr_wind::Factory< PostProcessBase, CFDSim &, const std::string & >
virtual	~Factory ()=default

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

Protected Attributes
int	m_out_interval {10}
	Time step interval for output.
amrex::Real	m_out_time_interval {-1.}
	Time interval for output.
int	m_out_delay {0}
	Time step delay for output.
amrex::Real	m_out_time_delay {0.}
	Time delay for output.
amrex::Real	m_out_time_tol {1e-8}
	Relative (to dt) tolerance for time interval output.
amrex::Real	m_enforce_dt_tol {1e-3}
	Relative (to m_out_time_interval) tolerance for enforcing dt.
bool	m_enforce_dt {false}
	Flag for enforcing time step based on output time.

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

Detailed Description

Abstract representation of a post-processing utility

Provides an interface for a runtime-selectable post-processing action (e.g., data sampling, volume/surface integration, etc.) with the main solver.

All post-processing utilities must derive from this class.

Constructor & Destructor Documentation

~PostProcessBase()

amr_wind::PostProcessBase::~PostProcessBase ( )

overridedefault

Member Function Documentation

base_identifier()

std::string amr_wind::PostProcessBase::base_identifier ( )

inlinestatic

do_output_now()

bool amr_wind::PostProcessBase::do_output_now ( const int ntime, const amrex::Real time, const amrex::Real dt, amrex::Real tol ) const

inline

Determine if output will happen this time step.

enforce_dt()

bool amr_wind::PostProcessBase::enforce_dt ( ) const

inline

enforce_dt_tolerance()

amrex::Real amr_wind::PostProcessBase::enforce_dt_tolerance ( ) const

inline

initialize()

virtual void amr_wind::PostProcessBase::initialize ( )

pure virtual

Initialize the post-processing utility

When this method is called, the mesh and the solution fields are fully initialized

output_actions()

virtual void amr_wind::PostProcessBase::output_actions ( )

pure virtual

Perform output routine

output_time_delay()

amrex::Real amr_wind::PostProcessBase::output_time_delay ( ) const

inline

output_time_interval()

amrex::Real amr_wind::PostProcessBase::output_time_interval ( ) const

inline

populate_output_parameters()

void amr_wind::PostProcessBase::populate_output_parameters ( amrex::ParmParse & pp )

inline

post_advance_work()

virtual void amr_wind::PostProcessBase::post_advance_work ( )

pure virtual

Perform actions at the end of each timestep

post_regrid_actions()

virtual void amr_wind::PostProcessBase::post_regrid_actions ( )

pure virtual

Actions to perform post regrid.

pre_init_actions()

virtual void amr_wind::PostProcessBase::pre_init_actions ( )

pure virtual

Member Data Documentation

m_enforce_dt

bool amr_wind::PostProcessBase::m_enforce_dt {false}

protected

Flag for enforcing time step based on output time.

m_enforce_dt_tol

amrex::Real amr_wind::PostProcessBase::m_enforce_dt_tol {1e-3}

protected

Relative (to m_out_time_interval) tolerance for enforcing dt.

m_out_delay

int amr_wind::PostProcessBase::m_out_delay {0}

protected

Time step delay for output.

m_out_interval

int amr_wind::PostProcessBase::m_out_interval {10}

protected

Time step interval for output.

m_out_time_delay

amrex::Real amr_wind::PostProcessBase::m_out_time_delay {0.}

protected

Time delay for output.

m_out_time_interval

amrex::Real amr_wind::PostProcessBase::m_out_time_interval {-1.}

protected

Time interval for output.

m_out_time_tol

amrex::Real amr_wind::PostProcessBase::m_out_time_tol {1e-8}

protected

Relative (to dt) tolerance for time interval output.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/PostProcessing.H