demComponent.hpp

Go to the documentation of this file.

/*------------------------------- phasicFlow ---------------------------------
      O        C enter of
     O O       E ngineering and
    O   O      M ultiscale modeling of
   OOOOOOO     F luid flow       
------------------------------------------------------------------------------
  Copyright (C): www.cemf.ir
  email: hamid.r.norouzi AT gmail.com
------------------------------------------------------------------------------  
Licence:
  This file is part of phasicFlow code. It is a free software for simulating 
  granular and multiphase flows. You can redistribute it and/or modify it under
  the terms of GNU General Public License v3 or any other later versions. 
 
  phasicFlow is distributed to help others in their research in the field of 
  granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-----------------------------------------------------------------------------*/
 
#ifndef __demComponent_hpp__ 
#define __demComponent_hpp__
 
#include "types.hpp"
#include "typeInfo.hpp"
#include "timeInfo.hpp"
#include "Timers.hpp"
 
namespace pFlow
{
 
class systemControl;
class Time;
class demComponent
{
private:
    // - Protected data members         
        
        systemControl&  control_;
 
        Time&           time_;
 
        Timers  timers_;
 
        word    componentName_;
 
public:
 
    TypeInfo("demComponent");
 
    // - Constructors
    
        demComponent(const word& name, systemControl& control);
        
        demComponent(const demComponent&) = delete;
 
        demComponent(demComponent&&) = delete;
 
        demComponent& operator = (const demComponent&) = delete;
 
        demComponent& operator =(demComponent&&) = delete;
 
        virtual ~demComponent() = default;
 
    
    // - Member functions 
 
        inline
        const auto& control()const
        {
            return control_;
        }
 
        inline
        auto& control()
        {
            return control_;
        }
 
        real dt()const;
        
        real currentTime()const;
 
        uint32 currentIter()const;
 
        timeInfo TimeInfo()const;
        
        inline
        const auto& time()const
        {
            return time_;
        }
 
        inline 
        auto& time()
        {
            return time_;
        }
 
 
        inline
        const auto& timers() const
        {
            return timers_;
        }
 
        inline
        auto& timers()
        {
            return timers_;
        }
 
        virtual
        bool beforeTimeLoop()
        {
            notImplementedFunction;
            return false;
        }
 
        virtual 
        bool beforeIteration() = 0;
 
        virtual 
        bool iterate() = 0;
 
        virtual 
        bool afterIteration() = 0;
 
        virtual
        bool afterTimeLoop()
        {
            notImplementedFunction;
            return false;
        }
 
};
 
}
 
#endif