container_expression.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Suneth Warnakulasuriya
//
 
#pragma once
 
// System includes
#include <cmath>
#include <string>
#include <variant>
#include <vector>
#include <optional>
 
// Project includes
#include "includes/define.h"
#include "includes/model_part.h"
#include "expression/expression.h"
#include "expression/container_expression_arithmetic_operators.h"
#include "expression/traits.h"
 
namespace Kratos {
 
 
template <class TContainerType, MeshType TMeshType = MeshType::Local>
class KRATOS_API(KRATOS_CORE) ContainerExpression {
public:
 
    using IndexType = std::size_t;
 
    KRATOS_CLASS_POINTER_DEFINITION(ContainerExpression);
 
 
    ContainerExpression(ModelPart& rModelPart);
 
    ContainerExpression(const ContainerExpression& rOther);
 
    ContainerExpression& operator=(const ContainerExpression& rOther);
 
    virtual ~ContainerExpression() = default;
 
 
    ContainerExpression::Pointer Clone() const;
 
    void CopyFrom(const ContainerExpression<TContainerType, TMeshType>& rOther);
 
 
    void SetExpression(Expression::ConstPointer pExpression);
 
    bool HasExpression() const;
 
    const Expression& GetExpression() const;
 
    Expression::ConstPointer pGetExpression() const;
 
    const std::vector<IndexType> GetItemShape() const;
 
    IndexType GetItemComponentCount() const;
 
    ModelPart* pGetModelPart() const;
 
    ModelPart& GetModelPart();
 
    const ModelPart& GetModelPart() const;
 
    TContainerType& GetContainer();
 
    const TContainerType& GetContainer() const;
 
    IndexType GetMaxDepth() const;
 
    virtual std::string Info() const;
 
    std::string PrintData() const;
 
 
    ContainerExpression& operator+=(const double Value);
 
    ContainerExpression& operator+=(const ContainerExpression& Value);
 
    ContainerExpression& operator-=(const double Value);
 
    ContainerExpression& operator-=(const ContainerExpression& Value);
 
    ContainerExpression& operator*=(const double Value);
 
    ContainerExpression& operator*=(const ContainerExpression& Value);
 
    ContainerExpression& operator/=(const double Value);
 
    ContainerExpression& operator/=(const ContainerExpression& Value);
 
protected:
 
    std::optional<Expression::ConstPointer> mpExpression;
 
    ModelPart* const mpModelPart;
 
};
 
 
template<class TContainerType, MeshType TMeshType>
inline std::ostream& operator<<(
    std::ostream& rOStream,
    const ContainerExpression<TContainerType, TMeshType>& rThis)
{
    return rOStream << rThis.Info();
}
 
 
} // namespace Kratos