controller.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Daniel Diez
//
 
#pragma once
 
// System includes
 
// External includes
 
// Project includes
#include "containers/model.h"
#include "includes/kratos_parameters.h"
 
namespace Kratos
{
 
 
class Controller
{
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(Controller);
 
 
    Controller() noexcept = default;
 
    virtual ~Controller() = default;
 
    //TODO: Check. It is required by the registry
    Controller(Controller const& rOther) = default;
 
    Controller(Controller&& rOther) noexcept = default;
 
 
    Controller& operator=(Controller const& rOther) = delete;
 
 
    virtual Controller::Pointer Create(
        Model& rModel,
        Parameters ThisParameters) const = 0;
 
    virtual int Check() const
    {
        return 0;
    }
 
    virtual bool Evaluate() const = 0;
 
    virtual void Update() {}
 
    virtual Parameters GetDefaultParameters() const
    {
        return Parameters(R"({})" );
    }
 
 
    virtual std::string Info() const
    {
        return "Controller";
    }
 
    virtual void PrintInfo(std::ostream& rOStream) const
    {
        rOStream << "Controller";
    }
 
    virtual void PrintData(std::ostream& rOStream) const
    {
    }
 
}; // Class Controller
 
 
 
std::istream& operator >> (std::istream& rIStream, Controller& rThis);
 
std::ostream& operator << (std::ostream& rOStream, const Controller& rThis)
{
    rThis.PrintInfo(rOStream);
    rOStream << std::endl;
    rThis.PrintData(rOStream);
 
    return rOStream;
}
 
}  // namespace Kratos.