# PhasicFlow: src/demComponent/demComponent.hpp Source File

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 "systemControl.hpp"
namespace pFlow
{
class demComponent
{
protected:
word componentName_;
systemControl& control_;
Timers timers_;
public:
TypeInfo("demComponent");
demComponent(const word& name, systemControl& control)
:
componentName_(name),
control_(control),
timers_(name, &control.timers())
{}
virtual ~demComponent() = default;
const auto& control()const
{
return control_;
}
auto& control()
{
return control_;
}
inline
real dt()const
{
return control_.time().dt();
}
inline
real currentTime()const
{
return control_.time().currentTime();
}
auto& timers(){
return timers_;
}
const auto& timers() const{
return timers_;
}
virtual bool beforeIteration() = 0;
virtual bool iterate() = 0;
virtual bool afterIteration() = 0;
};
}
#endif
pFlow::demComponent::demComponent
demComponent(const word &name, systemControl &control)
Definition: demComponent.hpp:47
pFlow::real
float real
Definition: builtinTypes.hpp:46
pFlow::demComponent::control
const auto & control() const
Definition: demComponent.hpp:57
pFlow::timeControl::dt
real dt() const
Definition: timeControl.hpp:102
systemControl.hpp
pFlow::word
std::string word
Definition: builtinTypes.hpp:63
pFlow::systemControl
Definition: systemControl.hpp:41
pFlow::Timers
Definition: Timers.hpp:33
pFlow::demComponent::afterIteration
virtual bool afterIteration()=0
pFlow::demComponent::timers
const auto & timers() const
Definition: demComponent.hpp:83
pFlow::demComponent::control
auto & control()
Definition: demComponent.hpp:62
pFlow::demComponent::control_
systemControl & control_
Definition: demComponent.hpp:38
pFlow
Definition: demComponent.hpp:28
pFlow::demComponent::timers_
Timers timers_
Definition: demComponent.hpp:41
pFlow::demComponent::dt
real dt() const
Definition: demComponent.hpp:68
pFlow::demComponent
Definition: demComponent.hpp:31
pFlow::systemControl::time
const Time & time() const
Definition: systemControl.hpp:123
pFlow::demComponent::beforeIteration
virtual bool beforeIteration()=0
pFlow::timeControl::currentTime
real currentTime() const
Definition: timeControl.hpp:131
pFlow::demComponent::currentTime
real currentTime() const
Definition: demComponent.hpp:74
pFlow::demComponent::componentName_
word componentName_
Definition: demComponent.hpp:35
pFlow::demComponent::~demComponent
virtual ~demComponent()=default
pFlow::demComponent::TypeInfo
TypeInfo("demComponent")
pFlow::demComponent::timers
auto & timers()
Definition: demComponent.hpp:79
pFlow::demComponent::iterate
virtual bool iterate()=0