collective_expression.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   license: OptimizationApplication/license.txt
//
//  Main author:     Suneth Warnakulasuriya
//
 
#pragma once
 
// System includes
#include <string>
#include <vector>
#include <variant>
 
// Project includes
#include "expression/container_expression.h"
#include "expression/traits.h"
#include "includes/define.h"
#include "includes/model_part.h"
 
// Application includes
#include "collective_expression_arithmetic_operators.h"
 
namespace Kratos {
 
 
class KRATOS_API(OPTIMIZATION_APPLICATION) CollectiveExpression {
public:
 
    using IndexType = std::size_t;
 
    using CollectiveExpressionType = std::variant<
            ContainerExpression<ModelPart::NodesContainerType>::Pointer,
            ContainerExpression<ModelPart::ConditionsContainerType>::Pointer,
            ContainerExpression<ModelPart::ElementsContainerType>::Pointer>;
 
    KRATOS_CLASS_POINTER_DEFINITION(CollectiveExpression);
 
 
    // Default constructor
    CollectiveExpression() noexcept = default;
 
 
    CollectiveExpression(const std::vector<CollectiveExpressionType>& rExpressionPointersList);
 
    // Copy consttructor
    CollectiveExpression(const CollectiveExpression& rOther);
 
    CollectiveExpression& operator=(const CollectiveExpression& rOther);
 
    // destructor
    ~CollectiveExpression() = default;
 
 
    CollectiveExpression Clone() const;
 
    void Add(const CollectiveExpressionType& pExpression);
 
    void Add(const CollectiveExpression& rCollectiveExpression);
 
    void Clear();
 
    IndexType GetCollectiveFlattenedDataSize() const;
 
    std::vector<CollectiveExpressionType> GetContainerExpressions();
 
    std::vector<CollectiveExpressionType> GetContainerExpressions() const;
 
    bool IsCompatibleWith(const CollectiveExpression& rOther) const;
 
 
    CollectiveExpression& operator+=(const CollectiveExpression& rOther);
 
    CollectiveExpression& operator+=(const double Value);
 
    CollectiveExpression& operator-=(const CollectiveExpression& rOther);
 
    CollectiveExpression& operator-=(const double Value);
 
    CollectiveExpression& operator*=(const CollectiveExpression& rOther);
 
    CollectiveExpression& operator*=(const double Value);
 
    CollectiveExpression& operator/=(const CollectiveExpression& rOther);
 
    CollectiveExpression& operator/=(const double Value);
 
 
    std::string Info() const;
 
private:
 
    std::vector<CollectiveExpressionType> mExpressionPointersList;
 
};
 
 
inline std::ostream& operator<<(
    std::ostream& rOStream,
    const CollectiveExpression& rThis)
{
    return rOStream << rThis.Info();
}
 
 
} // namespace Kratos