variable_data.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics 
//
//  License:         BSD License 
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Pooyan Dadvand
//                    
//
               
 
 
#if !defined(KRATOS_VARIABLE_DATA_H_INCLUDED )
#define  KRATOS_VARIABLE_DATA_H_INCLUDED
 
 
 
// System includes
#include <string>
#include <iostream>
#include <cstddef>
 
 
// External includes
 
 
// Project includes
#include "includes/define.h"
#include "utilities/counter.h"
#include "includes/serializer.h"
 
 
namespace Kratos
{
 
 
 
class KRATOS_API(KRATOS_CORE) VariableData
{
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(VariableData);
 
    typedef std::size_t KeyType;
 
 
    VariableData(const VariableData& rOtherVariable);
 
    virtual ~VariableData() {}
 
 
 
    operator size_t() const
    {
        return mKey;
    }
 
    
    virtual void* Clone(const void* pSource) const;
 
    virtual void* Copy(const void* pSource, void* pDestination) const;
 
    virtual void Assign(const void* pSource, void* pDestination) const;
 
    virtual void AssignZero(void* pDestination) const;
 
    virtual void Delete(void* pSource) const;
    
    virtual void Destruct(void* pSource) const;
 
    virtual void Print(const void* pSource, std::ostream& rOStream) const;
 
    virtual void PrintData(const void* pSource, std::ostream& rOStream) const;
 
    virtual void Allocate(void** pData) const;
    
    virtual void Save(Serializer& rSerializer, void* pData) const;
 
    virtual void Load(Serializer& rSerializer, void* pData) const;
 
 
    KeyType HashKey() const
    {
        KeyType key = mKey;// >> 8;
        key &= 0xFFFFFFFF00;
        return key;
    }
 
    KeyType Key() const
    {
        return mKey;
    }
 
    KeyType SourceKey() const
    {
        return mpSourceVariable->mKey;
    }
 
   void SetKey(KeyType NewKey);
 
    const std::string& Name() const
    {
        return mName;
    }
 
    std::size_t Size() const
    {
        return mSize;
    }
 
    bool IsComponent() const
    {
        return mIsComponent;
    }
 
    bool IsNotComponent() const
    {
        return !mIsComponent;
    }
 
 
    KeyType GetComponentIndex() const {
        constexpr KeyType first_7_bits=127;
        return (mKey & first_7_bits);
    }
 
    const VariableData& GetSourceVariable() const
    {   
        KRATOS_DEBUG_ERROR_IF(mpSourceVariable == nullptr) << "No source variable is defined for the component" << std::endl;
        return *mpSourceVariable;
    }
 
    virtual const void* pZero() const {
        KRATOS_ERROR << "Calling base class method." << std::endl;
    }
 
 
 
 
 
    virtual std::string Info() const;
 
    virtual void PrintInfo(std::ostream& rOStream) const;
 
    virtual void PrintData(std::ostream& rOStream) const;
 
 
 
    static KeyType GenerateKey(const std::string& Name, std::size_t Size, bool IsComponent, char ComponentIndex);
 
 
    friend bool operator==(const VariableData& rFirstVariable, const VariableData& rSecondVariable)
    {
        return (rFirstVariable.mKey == rSecondVariable.mKey);
    }
 
 
protected:
 
 
 
    VariableData& operator=(const VariableData& rOtherVariable)
    {
        mName = rOtherVariable.mName;
        mKey = rOtherVariable.mKey;
        mSize = rOtherVariable.mSize;
        mpSourceVariable = rOtherVariable.mpSourceVariable;
        mIsComponent = rOtherVariable.mIsComponent;
 
        return *this;
    }
 
 
    VariableData(const std::string& NewName, std::size_t NewSize);
 
    VariableData(const std::string& NewName, std::size_t NewSize, const VariableData* pSourceVariable, char ComponentIndex);
 
 
    VariableData() {}
 
 
private:
 
    std::string mName;
 
    KeyType mKey;
 
    std::size_t mSize;
 
    const VariableData* mpSourceVariable;
 
    bool mIsComponent;
    
 
    friend class Serializer;
 
    virtual void save(Serializer& rSerializer) const;
 
    virtual void load(Serializer& rSerializer);
 
 
}; // Class VariableData
 
 
 
 
inline std::istream& operator >> (std::istream& rIStream,
                                  VariableData& rThis);
 
inline std::ostream& operator << (std::ostream& rOStream,
                                  const VariableData& rThis)
{
    rThis.PrintInfo(rOStream);
    rThis.PrintData(rOStream);
 
    return rOStream;
}
 
 
 
}  // namespace Kratos.
 
#endif // KRATOS_VARIABLE_DATA_H_INCLUDED  defined