phasicFlow/src/phasicFlow/repository/Time/timeControl.cpp

/*------------------------------- 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.

-----------------------------------------------------------------------------*/


#include "timeControl.hpp"
#include "dictionary.hpp"


bool pFlow::timeControl::screenReport()const
{
	return screenReportInterval_.isMember(currentIter_);
}

pFlow::timeControl::timeControl
(
	const dictionary& dict
)
:
	dt_
	(
		dict.getVal<real>("dt")
	),
	startTime_
	(
		dict.getVal<real>("startTime")
	),
	endTime_
	(
		dict.getVal<real>("endTime")
	),
	stopAt_(endTime_),
	currentTime_(startTime_),
	saveInterval_
	(
		dict.getVal<real>("saveInterval")
	),
	lastSaved_(startTime_),
	currentIter_(0),
	timePrecision_
	(
		dict.getValOrSet("timePrecision", 4)
	),
	timersReportInterval_
	(
		startTime_,
		dict.getValOrSet("timersReportInterval", 0.04)
	),
	performSorting_
	(
		dict.getValOrSet("performSorting", Logical("No"))
	),
	sortingInterval_
	(
		startTime_,
		dict.getValOrSet("sortingInterval", static_cast<real>(1.0))
	)
{
	checkForOutputToFile();
}

pFlow::timeControl::timeControl(
		dictionary& dict,
		real startTime,
		real endTime,
		real saveInterval,
		word startTimeName)
:
	dt_
	(
		dict.getVal<real>("dt")
	),
	startTime_(startTime),
	endTime_(endTime),
	stopAt_(endTime_),
	currentTime_(startTime_),
	saveInterval_(saveInterval),
	lastSaved_(startTime_),
	currentIter_(0),
	timePrecision_
	(
		dict.getValOrSet("timePrecision", 4)
	),
	managedExternaly_(true),
	timeName_(startTimeName),
	timersReportInterval_
	(
		startTime_,
		dict.getValOrSet("timersReportInterval", 0.04)
	),
	performSorting_
	(
		dict.getValOrSet("performSorting", Logical("No"))
	),
	sortingInterval_
	(
		startTime_,
		dict.getValOrSet("sortingInterval", static_cast<real>(1.0))
	)	
{
	checkForOutputToFile();
}

pFlow::word pFlow::timeControl::timeName()const
{
	if(managedExternaly_)
		return timeName_;
	else
		return currentTimeWord();
}

bool pFlow::timeControl::finalTime()const
{
	if( currentTime_ >= endTime_ ) return true;
	if( abs(currentTime_-endTime_) < 0.5*dt_ )return true;
	return false;	
}

bool pFlow::timeControl::reachedStopAt()const
{
	if( currentTime_ >= stopAt_ ) return true;
	if( abs(currentTime_-stopAt_) < 0.5*dt_ )return true;
	return false;
}

void pFlow::timeControl::checkForOutputToFile()
{
	
	bool save = false;
	if(managedExternaly_)
	{
		if( abs(currentTime_-writeTime_) < 0.5*dt_)
		{
			save = true;
			lastSaved_ = currentTime_;
		}
	}
	else
	{
		if ( abs(currentTime_ - lastSaved_ - saveInterval_) < 0.5 * dt_ )
		{	
			lastSaved_ = currentTime_;
			save = true;
		}
		else if( abs(currentTime_ - lastSaved_) < min( pow(10.0,-1.0*timePrecision_), 0.5 *dt_) )
		{
			lastSaved_ = currentTime_;
			save = true;
		}
		
	}

	outputToFile_ = save;


}

bool pFlow::timeControl::timersReportTime()const
{
	if(currentIter_<=1)return false;
	return timersReportInterval_.isMember(currentTime_, dt_);
}

bool pFlow::timeControl::sortTime()const
{
	return performSorting_()&&sortingInterval_.isMember(currentTime_,dt_);
}

void pFlow::timeControl::setSaveTimeFolder(
	bool saveToFile, 
	const word& timeName)
{
	if(managedExternaly_)
	{
		outputToFile_ = saveToFile;
		timeName_ = timeName;
	}
}

bool pFlow::timeControl::operator ++(int)
{

	if( reachedStopAt() ) return false;
	// increament iteration number 
	currentIter_++;

	currentTime_ += dt_;
	if(screenReport() && !managedExternaly_)
	{
		REPORT(0)<<"Time (s): "<<cyanText( currentTimeWord() )<<endREPORT;
	}
	// switch outputToFile_ on/off
	checkForOutputToFile();

	return true;
}