WARPX/html/diagnostic_8h_source.html

#ifndef WXM_DIAGNOSTIC_H

#define WXM_DIAGNOSTIC_H


#include "hostactions/wmhostaction.h"


namespace wxm

{

namespace diagnostics

{

class Diagnostic : public WmHostAction

{

public:

    Diagnostic(const WmConstOpaquePtr& parent_solver) : WmHostAction(parent_solver)

    {

    }


    void setup(const WxCryptSet& wxc) override;


    virtual void runDiagnostic(std::vector<double>& res) = 0;


    WxStepperStatus step() override

    {

        return WxStepperStatus();

    }

};

} // namespace diagnostics

} // namespace wxm


#endif

WmConstOpaquePtr
Opaque Pointer object that carries the referenced data type, but does not expose this payload type as...
Definition: wmopaqueptr.h:81

WmHostAction
The WmHostAction class is a base class for sub-solvers in the WARPXM system.
Definition: wmhostaction.h:35

WxCryptSet
WxCryptSet extends WxCrypt by providing, in addition to name-value pairs, an set of named WxCryptSets...
Definition: wxcryptset.h:35

WxStepperStatus
Represents important parameters for the efficacy of a completing simulation step.
Definition: wxstepperstatus.h:19

wxm::diagnostics::Diagnostic
A simulation diagnostic.
Definition: diagnostic.h:18

wxm::diagnostics::Diagnostic::Diagnostic
Diagnostic(const WmConstOpaquePtr &parent_solver)
Definition: diagnostic.h:20

wxm::diagnostics::Diagnostic::setup
void setup(const WxCryptSet &wxc) override
Setup object using supplied crypset.

wxm::diagnostics::Diagnostic::step
WxStepperStatus step() override
Default is a No-op since Diagnostics should implement the runDiagnostic method.
Definition: diagnostic.h:37

wxm::diagnostics::Diagnostic::runDiagnostic
virtual void runDiagnostic(std::vector< double > &res)=0
Run the diagnostic.

wxm
Base namespace for everything not included in the global namespace.
Definition: field_source.h:8

wmhostaction.h