OilfieldToolsNet/opm-core
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cleanup: reportStepIdx --> writeStepIdx.

Browse Source 
startDate     --> startDateTime
         removal of debug output.
This commit is contained in:
Robert K 2015-01-09 15:10:56 +01:00
parent 6eeecbb02b
commit 65a314db92
8 changed files with 58 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
opm/core/io/eclipse/EclipseWriter.cpp
View File

@ -235,13 +235,13 @@ public:
FileName(const std::string& outputDir,
const std::string& baseName,
ecl_file_enum type,
int reportStepIdx)
int writeStepIdx)
{
ertHandle_ = ecl_util_alloc_filename(outputDir.c_str(),
baseName.c_str(),
type,
false, // formatted?
reportStepIdx);
writeStepIdx);
}
~FileName()
@ -276,15 +276,15 @@ public:
Restart(const std::string& outputDir,
const std::string& baseName,
int reportStepIdx)
int writeStepIdx)
{
restartFileName_ = ecl_util_alloc_filename(outputDir.c_str(),
baseName.c_str(),
/*type=*/ECL_UNIFIED_RESTART_FILE,
false, // use formatted instead of binary output?
reportStepIdx);
writeStepIdx);
if (reportStepIdx == 0) {
if (writeStepIdx == 0) {
restartFileHandle_ = ecl_rst_file_open_write(restartFileName_);
}
else {
@ -371,12 +371,12 @@ public:
}
void writeHeader(const SimulatorTimerInterface& timer,
int reportStepIdx,
int writeStepIdx,
ecl_rsthead_type * rsthead_data)
{
ecl_rst_file_fwrite_header(restartFileHandle_,
reportStepIdx,
writeStepIdx,
rsthead_data);
}
@ -461,7 +461,7 @@ public:
// add rate variables for each of the well in the input file
void addAllWells(Opm::EclipseStateConstPtr eclipseState,
const PhaseUsage& uses);
void writeTimeStep(int reportStepIdx,
void writeTimeStep(int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState);
@ -479,11 +479,11 @@ class SummaryTimeStep : private boost::noncopyable
{
public:
SummaryTimeStep(Summary& summaryHandle,
int reportStepIdx,
int writeStepIdx,
const SimulatorTimerInterface &timer)
{
ertHandle_ = ecl_sum_add_tstep(summaryHandle.ertHandle(),
reportStepIdx,
writeStepIdx,
Opm::unit::convert::to(timer.simulationTimeElapsed(),
Opm::unit::day));
}
@ -508,16 +508,16 @@ class Init : private boost::noncopyable
public:
Init(const std::string& outputDir,
const std::string& baseName,
int reportStepIdx)
int writeStepIdx)
: egridFileName_(outputDir,
baseName,
ECL_EGRID_FILE,
reportStepIdx)
writeStepIdx)
{
FileName initFileName(outputDir,
baseName,
ECL_INIT_FILE,
reportStepIdx);
writeStepIdx);
bool isFormatted;
if (!ecl_util_fmt_file(initFileName.ertHandle(), &isFormatted)) {
@ -619,7 +619,7 @@ protected:
public:
/// Retrieve the value which the monitor is supposed to write to the summary file
/// according to the state of the well.
virtual double retrieveValue(const int reportStepIdx,
virtual double retrieveValue(const int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState,
const std::map<std::string, int>& nameToIdxMap) = 0;
@ -751,7 +751,7 @@ public:
"SM3/DAY" /* surf. cub. m. per day */)
{ }
virtual double retrieveValue(const int reportStepIdx,
virtual double retrieveValue(const int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState,
const std::map<std::string, int>& wellNameToIdxMap)
@ -797,12 +797,12 @@ public:
, total_(0.)
{ }
virtual double retrieveValue(const int reportStepIdx,
virtual double retrieveValue(const int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState,
const std::map<std::string, int>& wellNameToIdxMap)
{
if (reportStepIdx == 0) {
if (writeStepIdx == 0) {
// We are at the initial state.
// No step has been taken yet.
return 0.0;
@ -856,7 +856,7 @@ public:
"Pascal")
{ }
virtual double retrieveValue(const int reportStepIdx,
virtual double retrieveValue(const int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState,
const std::map<std::string, int>& wellNameToIdxMap)
@ -878,7 +878,7 @@ public:
// no inline implementation of this since it depends on the
// WellReport type being completed first
void Summary::writeTimeStep(int reportStepIdx,
void Summary::writeTimeStep(int writeStepIdx,
const SimulatorTimerInterface& timer,
const WellState& wellState)
{
@ -895,12 +895,12 @@ void Summary::writeTimeStep(int reportStepIdx,
}
// internal view; do not move this code out of Summary!
SummaryTimeStep tstep(*this, reportStepIdx, timer);
SummaryTimeStep tstep(*this, writeStepIdx, timer);
// write all the variables
for (auto varIt = summaryReportVars_.begin(); varIt != summaryReportVars_.end(); ++varIt) {
ecl_sum_tstep_iset(tstep.ertHandle(),
smspec_node_get_params_index((*varIt)->ertHandle()),
(*varIt)->retrieveValue(reportStepIdx, timer, wellState, wellNameToIdxMap));
(*varIt)->retrieveValue(writeStepIdx, timer, wellState, wellNameToIdxMap));
}
// write the summary file to disk
@ -1023,7 +1023,7 @@ void EclipseWriter::writeInit(const SimulatorTimerInterface &timer)
return;
}
reportStepIdx_ = 0;
writeStepIdx_ = 0;
EclipseWriterDetails::Init fortio(outputDir_, baseName_, /*stepIdx=*/0);
fortio.writeHeader(numCells_,
@ -1072,7 +1072,7 @@ void EclipseWriter::writeTimeStep(const SimulatorTimerInterface& timer,
}
// respected the output_interval parameter
if (reportStepIdx_ % outputInterval_ != 0) {
if (writeStepIdx_ % outputInterval_ != 0) {
return;
}
@ -1095,7 +1095,7 @@ void EclipseWriter::writeTimeStep(const SimulatorTimerInterface& timer,
rsthead_data.ncwmax = 0;
rsthead_data.phase_sum = Opm::EclipseWriterDetails::ertPhaseMask(phaseUsage_);
EclipseWriterDetails::Restart restartHandle(outputDir_, baseName_, reportStepIdx_);
EclipseWriterDetails::Restart restartHandle(outputDir_, baseName_, writeStepIdx_);
for (std::vector<WellConstPtr>::const_iterator c_iter = wells_ptr.begin(); c_iter != wells_ptr.end(); ++c_iter) {
WellConstPtr well_ptr = *c_iter;
@ -1113,7 +1113,7 @@ void EclipseWriter::writeTimeStep(const SimulatorTimerInterface& timer,
rsthead_data.sim_days = Opm::unit::convert::to(timer.simulationTimeElapsed(), Opm::unit::day); //data for doubhead
restartHandle.writeHeader(timer,
reportStepIdx_,
writeStepIdx_,
&rsthead_data);
@ -1165,9 +1165,9 @@ void EclipseWriter::writeTimeStep(const SimulatorTimerInterface& timer,
// instead of creating a temporary EclipseWriterDetails::Summary in this function
// every time it is called. This has been changed so that the final summary file
// will contain data from the whole simulation, instead of just the last step.
summary_->writeTimeStep(reportStepIdx_, timer, wellState);
summary_->writeTimeStep(writeStepIdx_, timer, wellState);
++reportStepIdx_;
++writeStepIdx_;
}
@ -1243,7 +1243,7 @@ void EclipseWriter::init(const parameter::ParameterGroup& params)
outputDir_ = params.getDefault<std::string>("output_dir", ".");
// set the index of the first time step written to 0...
reportStepIdx_ = 0;
writeStepIdx_ = 0;
if (enableOutput_) {
// make sure that the output directory exists, if not try to create it

2
opm/core/io/eclipse/EclipseWriter.hpp
View File

@ -114,7 +114,7 @@ private:
double deckToSiPressure_;
bool enableOutput_;
int outputInterval_;
int reportStepIdx_;
int writeStepIdx_;
std::string outputDir_;
std::string baseName_;
PhaseUsage phaseUsage_; // active phases in the input deck

6
opm/core/simulator/AdaptiveSimulatorTimer.cpp
View File

@ -31,7 +31,7 @@ namespace Opm
{
AdaptiveSimulatorTimer::
AdaptiveSimulatorTimer( const SimulatorTimerInterface& timer, const double lastStepTaken )
: start_date_( timer.startDate() )
: start_date_time_( timer.startDateTime() )
, start_time_( timer.simulationTimeElapsed() )
, total_time_( start_time_ + timer.currentStepLength() )
, report_step_( timer.reportStepNum() )
@ -156,9 +156,9 @@ namespace Opm
std::cout << "sub steps end time = " << unit::convert::to( simulationTimeElapsed(), unit::day ) << " (days)" << std::endl;
}
boost::gregorian::date AdaptiveSimulatorTimer::startDate() const
boost::posix_time::ptime AdaptiveSimulatorTimer::startDateTime() const
{
return start_date_;
return start_date_time_;
}
double AdaptiveSimulatorTimer::

6
opm/core/simulator/AdaptiveSimulatorTimer.hpp
View File

@ -89,11 +89,11 @@ namespace Opm
/// \brief report start and end time as well as used steps so far
void report(std::ostream& os) const;
/// \brief start date of simulation
boost::gregorian::date startDate() const;
/// \brief start date time of simulation
boost::posix_time::ptime startDateTime() const;
protected:
const boost::gregorian::date start_date_;
const boost::posix_time::ptime start_date_time_;
const double start_time_;
const double total_time_;
const int report_step_;

11
opm/core/simulator/AdaptiveTimeStepping_impl.hpp
View File

@ -151,7 +151,12 @@ namespace Opm {
std::cout << std::endl
<<"Substep( " << substepTimer.currentStepNum()
<< " ): Current time (days) " << unit::convert::to(substepTimer.simulationTimeElapsed(),unit::day) << std::endl
<< " Current stepsize est (days) " << unit::convert::to(dtEstimate, unit::day) << std::endl;
<< " Current stepsize est (days) " << unit::convert::to(dtEstimate, unit::day) << std::endl;
}
// write data if outputWriter was provided
if( outputWriter ) {
outputWriter->writeTimeStep( substepTimer, state, well_state );
}
// set new time step length
@ -161,10 +166,6 @@ namespace Opm {
last_state = state ;
last_well_state = well_state;
// write data if outputWriter was provided
if( outputWriter ) {
outputWriter->writeTimeStep( substepTimer, state, well_state );
}
}
else // in case of no convergence (linearIterations < 0)
{

4
opm/core/simulator/SimulatorTimer.cpp
View File

@ -100,9 +100,9 @@ namespace Opm
return current_time_;
}
boost::gregorian::date SimulatorTimer::startDate() const
boost::posix_time::ptime SimulatorTimer::startDateTime() const
{
return start_date_;
return boost::posix_time::ptime(start_date_);
}

2
opm/core/simulator/SimulatorTimer.hpp
View File

@ -83,7 +83,7 @@ namespace Opm
double totalTime() const;
/// Return start date of simulation
boost::gregorian::date startDate() const;
boost::posix_time::ptime startDateTime() const;
/// Set total time.
/// This is primarily intended for multi-epoch schedules,

20
opm/core/simulator/SimulatorTimerInterface.hpp
View File

@ -37,6 +37,9 @@ namespace Opm
SimulatorTimerInterface() {}
public:
/// destructor
virtual ~SimulatorTimerInterface() {}
/// Current step number. This is the number of timesteps that
/// has been completed from the start of the run. The time
/// after initialization but before the simulation has started
@ -60,6 +63,14 @@ namespace Opm
/// it is an error to call stepLengthTaken().
virtual double stepLengthTaken () const = 0;
/// Previous report step length. This is the length of the step that
/// was taken to arrive at this report step time.
///
/// @note if no increments have been done (i.e. the timer is
/// still in its constructed state and reportStepNum() == 0),
/// it is an error to call stepLengthTaken().
virtual double reportStepLengthTaken () const { return stepLengthTaken(); }
/// Time elapsed since the start of the simulation until the
/// beginning of the current time step [s].
virtual double simulationTimeElapsed() const = 0;
@ -68,12 +79,13 @@ namespace Opm
virtual bool done() const = 0;
/// Return start date of simulation
virtual boost::gregorian::date startDate() const = 0;
virtual boost::posix_time::ptime startDateTime() const = 0;
/// Return the current time as a posix time object.
virtual boost::posix_time::ptime currentDateTime() const
{
return boost::posix_time::ptime(startDate()) + boost::posix_time::seconds( (int) simulationTimeElapsed());
return startDateTime() + boost::posix_time::seconds( (int) simulationTimeElapsed());
//boost::posix_time::ptime(startDate()) + boost::posix_time::seconds( (int) simulationTimeElapsed());
}
/// Time elapsed since the start of the POSIX epoch (Jan 1st,
@ -83,10 +95,6 @@ namespace Opm
tm t = boost::posix_time::to_tm(currentDateTime());
return std::mktime(&t);
}
/// Print a report with current and total time etc.
/// Note: if done(), it is an error to call report().
//virtual void report(std::ostream& os) const = 0;
};