libMesh
Public Member Functions | List of all members
libMesh::System::QOI Class Referenceabstract

Abstract base class to be used for quantities of interest. More...

#include <system.h>

Public Member Functions

virtual ~QOI ()=default
 Destructor. More...
 
virtual void qoi (const QoISet &qoi_indices)=0
 Quantity of interest function. More...
 

Detailed Description

Abstract base class to be used for quantities of interest.

A user class derived from this class may be used to compute quantities of interest by attaching an object with the method attach_QOI_object.

Definition at line 203 of file system.h.

Constructor & Destructor Documentation

◆ ~QOI()

virtual libMesh::System::QOI::~QOI ( )
virtualdefault

Destructor.

Virtual because we will have virtual functions.

Member Function Documentation

◆ qoi()

virtual void libMesh::System::QOI::qoi ( const QoISet qoi_indices)
pure virtual

Quantity of interest function.

This function will be called to compute quantities of interest and must be provided by the user in a derived class.

Referenced by libMesh::System::user_QOI().


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