process.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Pooyan Dadvand
//                   Riccardo Rossi
//
 
#pragma once
 
// System includes
 
// External includes
 
// Project includes
#include "includes/define.h"
#include "includes/kratos_flags.h"
#include "includes/kratos_parameters.h"
#include "includes/define_registry.h"
 
namespace Kratos
{
 
 
// Some forward declarations to avoid increase a lot the compilation time
class Model;
 
class Process : public Flags
{
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(Process);
 
 
    Process() : Flags() {}
    explicit Process(const Flags options) : Flags( options ) {}
 
    ~Process() override {}
 
 
    void operator()()
    {
        Execute();
    }
 
 
    virtual Process::Pointer Create(
        Model& rModel,
        Parameters ThisParameters
        )
    {
        KRATOS_ERROR << "Calling base class create. Please override this method in the corresonding Process" << std::endl;
        return nullptr;
    }
 
    virtual void Execute() {}
 
    virtual void ExecuteInitialize()
    {
    }
 
    virtual void ExecuteBeforeSolutionLoop()
    {
    }
 
 
    virtual void ExecuteInitializeSolutionStep()
    {
    }
 
    virtual void ExecuteFinalizeSolutionStep()
    {
    }
 
 
    virtual void ExecuteBeforeOutputStep()
    {
    }
 
 
    virtual void ExecuteAfterOutputStep()
    {
    }
 
 
    virtual void ExecuteFinalize()
    {
    }
 
    virtual int Check()
    {
        return 0;
    }
 
    virtual void Clear()
    {
    }
 
    virtual const Parameters GetDefaultParameters() const
    {
        KRATOS_ERROR << "Calling the base Process class GetDefaultParameters. Please implement the GetDefaultParameters in your derived process class." << std::endl;
        const Parameters default_parameters = Parameters(R"({})" );
 
        return default_parameters;
    }
 
 
 
 
    std::string Info() const override
    {
        return "Process";
    }
 
    void PrintInfo(std::ostream& rOStream) const override
    {
        rOStream << Info();
    }
 
    void PrintData(std::ostream& rOStream) const override
    {
    }
 
 
private:
 
    KRATOS_REGISTRY_ADD_PROTOTYPE("Processes.KratosMultiphysics", Process, Process)
    KRATOS_REGISTRY_ADD_PROTOTYPE("Processes.All", Process, Process)
 
    
 
    Process& operator=(Process const& rOther);
 
    //Process(Process const& rOther);
 
 
}; // Class Process
 
 
 
 
inline std::istream& operator >> (std::istream& rIStream,
                                  Process& rThis);
 
inline std::ostream& operator << (std::ostream& rOStream,
                                  const Process& rThis)
{
    rThis.PrintInfo(rOStream);
    rOStream << std::endl;
    rThis.PrintData(rOStream);
 
    return rOStream;
}
 
}  // namespace Kratos.