wmhostaction.h

Go to the documentation of this file.

#ifndef wmhostaction_h
#define wmhostaction_h
 
// WarpX lib includes
#include "lib/wxcrypt.h"
#include "lib/wxmsgbase.h"
#include "lib/wxobject.h"
#include "solver/wxstepper.h"
#include "lib/wmdomain.h"
 
// std includes
#include <string>
#include <typeinfo>
#include <vector>
 
// forward declarations
class WmSolverBase;
class WmVariable;
class WmDomainGeometry;
class WmConstOpaquePtr;
 
template<class stepper> class WmExecutionStep;
class WmDomain;
 
class WmHostAction : public WxStepper, public WxObject
{
public:
    ~WmHostAction() override;
 
    void setup(const WxCryptSet& wxc) override;
 
    std::vector<std::string> readVarNames() const;
 
    std::vector<std::string> writeVarNames() const;
 
    unsigned numExpectedReadVars() const;
 
    unsigned numExpectedWriteVars() const;
 
    bool allowsVariableReadVars() const;
 
    bool allowsVariableWriteVars() const;
 
    virtual bool needsDomain() const;
 
    void setParentStepHandler(WmExecutionStep<WmHostAction>* parentStepHandler);
 
    unsigned numActualReadVars() const;
 
    unsigned numActualWriteVars() const;
 
    //  /**
    //   * Get domain on which host action works
    //   * TODO: Not all host actions work on a domain, yet the current implementation of
    //this function does not respect that. I'm thinking there should be a derived class
    //from WmHostAction : WmHostActionOnDomain.
    //   * @return domain object
    //   */
    //  const WmDomainGeometry& getDomain() const;
 
    const WmDomain& getDomain() const;
 
    std::vector<std::string> getWriteVarList() const;
 
    std::vector<std::string> getReadVarList() const;
 
    const WmSolverBase& getParent() const;
 
protected:
    WmHostAction(const WmConstOpaquePtr& parent_solver);
 
    const std::type_info& getVarType(const std::string& variableName) const;
 
    const wxm::variable::variable_t& getReadVar(unsigned pos) const;
    wxm::variable::variable_t& getWriteVar(unsigned pos) const;
 
protected:
    virtual void typeCheck() = 0;
 
    bool _allReadVarsSameType;
    bool _allWriteVarsSameType;
    bool _allowsVariableReadVars;  // true when variable number of read variables allowed
                                   // by hostaction
    bool _allowsVariableWriteVars; // true when variable number of write variables allowed
                                   // by hostaction
    bool _WriteVarConditionHasBeenSet; // true after first time hostaction has been
                                       // established as variable or fixed number of
                                       // variables
    bool _ReadVarConditionHasBeenSet;  // true after first time hostaction has been
                                       // established as variable or fixed number of
                                       // variables
    unsigned _numExpectedReadVars;
    unsigned _numExpectedWriteVars;
 
private:
    WmHostAction& operator=(const WmHostAction& var);
    WmHostAction(const WmHostAction& var);
    WmHostAction();
 
    const WmSolverBase* _parent;         // parent solver
    std::vector<std::string> _readVars;  // variables to read from
    std::vector<std::string> _writeVars; // variables to write to
    std::string _onDomainStr; // domain on which solver acts, if needsDomain returns true
    unsigned _numActualReadVars;
    unsigned _numActualWriteVars;
};
 
#endif //  wmhostaction_h