modeler.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Riccardo Rossi
//
//
 
 
#if !defined(KRATOS_MODELER_H_INCLUDED )
#define  KRATOS_MODELER_H_INCLUDED
 
 
// System includes
 
// External includes
 
// Project includes
#include "includes/define.h"
#include "containers/model.h"
#include "includes/kratos_components.h"
 
namespace Kratos
{
 
 
/* The modeler is designed to interact, create and update
   the ModelPart of the analyses after and at certain steps.
*/
class Modeler
{
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(Modeler);
 
    typedef std::size_t SizeType;
    typedef std::size_t IndexType;
 
 
    Modeler(
        Parameters ModelerParameters = Parameters())
        : mParameters(ModelerParameters)
        , mEchoLevel(
            ModelerParameters.Has("echo_level")
            ? ModelerParameters["echo_level"].GetInt()
            : 0)
    {}
 
    Modeler(
        Model& rModel,
        Parameters ModelerParameters = Parameters())
        : mParameters(ModelerParameters)
        , mEchoLevel(
            ModelerParameters.Has("echo_level")
            ? ModelerParameters["echo_level"].GetInt()
            : 0)
    {}
 
    virtual ~Modeler() = default;
 
    virtual Modeler::Pointer Create(
        Model& rModel, const Parameters ModelParameters) const
    {
        KRATOS_ERROR << "Trying to Create Modeler. Please check derived class 'Create' definition." << std::endl;
    }
 
 
    virtual void SetupGeometryModel()
    {}
 
    virtual void PrepareGeometryModel()
    {}
 
    virtual void SetupModelPart()
    {}
 
    virtual const Parameters GetDefaultParameters() const
    {
        KRATOS_ERROR << "Calling the base Modeler class GetDefaultParameters. Please implement the GetDefaultParameters in your derived model class." << std::endl;
        const Parameters default_parameters = Parameters(R"({})");
        return default_parameters;
    }
 
 
    virtual void GenerateModelPart(ModelPart& rOriginModelPart, ModelPart& rDestinationModelPart, Element const& rReferenceElement, Condition const& rReferenceBoundaryCondition)
    {
        KRATOS_ERROR << "This modeler CAN NOT be used for mesh generation." << std::endl;
    }
 
    virtual void GenerateMesh(ModelPart& ThisModelPart, Element const& rReferenceElement, Condition const& rReferenceBoundaryCondition)
    {
        KRATOS_ERROR << "This modeler CAN NOT be used for mesh generation." << std::endl;
    }
 
    virtual void GenerateNodes(ModelPart& ThisModelPart)
    {
        KRATOS_ERROR << "This modeler CAN NOT be used for node generation." << std::endl;
    }
 
 
    virtual std::string Info() const
    {
        return "Modeler";
    }
 
    virtual void PrintInfo(std::ostream& rOStream) const
    {
        rOStream << Info();
    }
 
    virtual void PrintData(std::ostream& rOStream) const
    {
    }
 
 
protected:
 
    Parameters mParameters;
 
    SizeType mEchoLevel;
 
 
}; // Class Modeler
 
 
inline std::istream& operator >> (std::istream& rIStream,
                                  Modeler& rThis);
 
inline std::ostream& operator << (std::ostream& rOStream,
                                  const Modeler& rThis)
{
    rThis.PrintInfo(rOStream);
    rOStream << std::endl;
    rThis.PrintData(rOStream);
 
    return rOStream;
}
 
KRATOS_API_EXTERN template class KRATOS_API(KRATOS_CORE) KratosComponents<Modeler>;
 
void KRATOS_API(KRATOS_CORE) AddKratosComponent(std::string const& Name, Modeler const& ThisComponent);
 
}  // namespace Kratos.
 
#endif // KRATOS_MODELER_H_INCLUDED  defined