PostProcessBase Class Reference

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

#include <PostProcessing.H>

Inheritance diagram for amr_wind::PostProcessBase:
[legend]
Collaboration diagram for amr_wind::PostProcessBase:
[legend]

Public Member Functions

 ~PostProcessBase () override=default
 
virtual void pre_init_actions ()=0
 
virtual void initialize ()=0
 
virtual void post_advance_work ()=0
 
virtual void post_regrid_actions ()=0
 Actions to perform post regrid.
 
- 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< PostProcessBasecreate (const std::string &key, Args... args)
 
static void print (std::ostream &os)
 

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()

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

◆ 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

◆ 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

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