Variable.h

Go to the documentation of this file.

#ifndef included_AMP_Variable_h
#define included_AMP_Variable_h
 
#include "AMP/utils/Units.h"
#include "AMP/utils/enable_shared_from_this.h"
 
#include <memory>
#include <string_view>
 
 
namespace AMP::IO {
class RestartManager;
}
 
 
namespace AMP::LinearAlgebra {
 
enum class ScatterType : uint8_t { CONSISTENT_ADD, CONSISTENT_SET };
 
enum class UpdateState : uint8_t {
    UNCHANGED     = 0,
    LOCAL_CHANGED = 1,
    ADDING        = 2,
    SETTING       = 3,
    MIXED         = 4
};
 
 
class VectorSelector;
 
 
class Variable : public AMP::enable_shared_from_this<Variable>
{
public:
    // Empty constructor
    Variable() = default;
 
    explicit Variable( const std::string &name );
 
 
    virtual ~Variable();
 
 
    virtual void setUnits( const Units &u );
 
 
    virtual const Units &getUnits() const;
 
 
    inline auto &getName() const { return d_VariableName; }
 
 
    virtual std::string className() const { return "Variable"; }
 
 
    virtual bool operator==( const Variable &rhs ) const;
 
 
    bool operator!=( const Variable &rhs ) const;
 
 
    std::shared_ptr<Variable> clone() const;
 
 
    virtual std::shared_ptr<Variable> clone( const std::string &name ) const;
 
 
    virtual std::shared_ptr<VectorSelector> createVectorSelector() const;
 
 
    virtual uint64_t getID() const;
 
 
public: // Write/read restart data
    virtual void registerChildObjects( AMP::IO::RestartManager *manager ) const;
 
    virtual void writeRestart( int64_t fid ) const;
 
 
    Variable( int64_t fid );
 
 
protected:
    std::string d_VariableName;
 
    AMP::Units d_Units;
};
 
} // namespace AMP::LinearAlgebra
 
#endif