ResInsight/ApplicationCode/ProjectDataModel/RimWellLogFile.cpp
2018-11-05 14:42:39 +01:00

348 lines
12 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2015- Statoil ASA
// Copyright (C) 2015- Ceetron Solutions AS
//
// ResInsight is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html>
// for more details.
//
/////////////////////////////////////////////////////////////////////////////////
#include "RimWellLogFile.h"
#include "RiaDateStringParser.h"
#include "RiaFieldHandleTools.h"
#include "RiaQDateTimeTools.h"
#include "RigWellLogFile.h"
#include "RimFileWellPath.h"
#include "RimTools.h"
#include "RimWellLogFileChannel.h"
#include "RimWellPathCollection.h"
#include "RimWellPlotTools.h"
#include "Riu3DMainWindowTools.h"
#include "cafPdmUiDateEditor.h"
#include <QFileInfo>
#include <QMessageBox>
#include <QStringList>
CAF_PDM_SOURCE_INIT(RimWellLogFile, "WellLogFile");
namespace caf
{
template<>
void caf::AppEnum< RimWellLogFile::WellFlowCondition>::setUp()
{
addItem(RimWellLogFile::WELL_FLOW_COND_RESERVOIR, "RESERVOIR", "Reservoir Volumes");
addItem(RimWellLogFile::WELL_FLOW_COND_STANDARD, "STANDARD", "Standard Volumes");
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
const QDateTime RimWellLogFile::DEFAULT_DATE_TIME = RiaQDateTimeTools::createUtcDateTime(QDate(1900, 1, 1));
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogFile::RimWellLogFile()
{
CAF_PDM_InitObject("Well LAS File Info", ":/LasFile16x16.png", "", "");
CAF_PDM_InitFieldNoDefault(&m_wellName, "WellName", "", "", "", "");
m_wellName.uiCapability()->setUiReadOnly(true);
RiaFieldhandleTools::disableWriteAndSetFieldHidden(&m_wellName);
CAF_PDM_InitFieldNoDefault(&m_date, "Date", "Date", "", "", "");
m_date.uiCapability()->setUiReadOnly(true);
CAF_PDM_InitFieldNoDefault(&m_fileName, "FileName", "Filename", "", "", "");
m_fileName.uiCapability()->setUiReadOnly(true);
CAF_PDM_InitFieldNoDefault(&m_name, "Name", "", "", "", "");
m_name.uiCapability()->setUiReadOnly(true);
RiaFieldhandleTools::disableWriteAndSetFieldHidden(&m_name);
CAF_PDM_InitFieldNoDefault(&m_wellLogChannelNames, "WellLogFileChannels", "", "", "", "");
RiaFieldhandleTools::disableWriteAndSetFieldHidden(&m_wellLogChannelNames);
CAF_PDM_InitField(&m_wellFlowCondition, "WellFlowCondition", caf::AppEnum<RimWellLogFile::WellFlowCondition>(RimWellLogFile::WELL_FLOW_COND_STANDARD), "Well Flow Rates", "", "", "");
CAF_PDM_InitField(&m_invalidDateMessage, "InvalidDateMessage", QString("Invalid or no date"), "", "", "", "");
m_invalidDateMessage.uiCapability()->setUiReadOnly(true);
m_invalidDateMessage.xmlCapability()->disableIO();
m_wellLogDataFile = nullptr;
m_lasFileHasValidDate = false;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogFile::~RimWellLogFile()
{
m_wellLogChannelNames.deleteAllChildObjects();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimWellLogFile* RimWellLogFile::readWellLogFile(const QString& logFilePath)
{
QFileInfo fi(logFilePath);
RimWellLogFile* wellLogFile = nullptr;
if (fi.suffix().toUpper().compare("LAS") == 0)
{
QString errorMessage;
wellLogFile = new RimWellLogFile();
wellLogFile->setFileName(logFilePath);
if (!wellLogFile->readFile(&errorMessage))
{
QString displayMessage = "Could not open the LAS file: \n" + logFilePath;
if (!errorMessage.isEmpty())
{
displayMessage += "\n\n";
displayMessage += errorMessage;
}
QMessageBox::warning(Riu3DMainWindowTools::mainWindowWidget(),
"File open error",
displayMessage);
delete wellLogFile;
wellLogFile = nullptr;
}
}
return wellLogFile;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::setFileName(const QString& fileName)
{
m_fileName = fileName;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWellLogFile::readFile(QString* errorMessage)
{
if (!m_wellLogDataFile.p())
{
m_wellLogDataFile = new RigWellLogFile;
}
m_name = QFileInfo(m_fileName).fileName();
if (!m_wellLogDataFile->open(m_fileName, errorMessage))
{
m_wellLogDataFile = nullptr;
return false;
}
m_wellName = m_wellLogDataFile->wellName();
QDateTime date = RiaDateStringParser::parseDateString(m_wellLogDataFile->date());
m_lasFileHasValidDate = isDateValid(date);
if (m_lasFileHasValidDate)
{
m_date = date;
}
else if(!isDateValid(m_date()))
{
QMessageBox msgBox;
QString message = QString("The LAS-file '%1' contains no recognizable date. Please assign a date in the LAS-file property panel")
.arg(m_name());
msgBox.setText(message);
msgBox.setStandardButtons(QMessageBox::Ok);
msgBox.exec();
m_date = DEFAULT_DATE_TIME;
}
m_wellLogChannelNames.deleteAllChildObjects();
QStringList wellLogNames = m_wellLogDataFile->wellLogChannelNames();
for (int logIdx = 0; logIdx < wellLogNames.size(); logIdx++)
{
RimWellLogFileChannel* wellLog = new RimWellLogFileChannel();
wellLog->setName(wellLogNames[logIdx]);
m_wellLogChannelNames.push_back(wellLog);
}
RimFileWellPath* wellPath;
this->firstAncestorOrThisOfType(wellPath);
if (wellPath)
{
if (wellPath->filepath().isEmpty()) // Has dummy wellpath
{
wellPath->setName(m_wellName);
}
}
return true;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RimWellLogFile::wellName() const
{
return m_wellName;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QDateTime RimWellLogFile::date() const
{
return m_date;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RimWellLogFileChannel*> RimWellLogFile::wellLogChannels() const
{
std::vector<RimWellLogFileChannel*> channels;
for (const auto& channel : m_wellLogChannelNames)
{
channels.push_back(channel);
}
return channels;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWellLogFile::hasFlowData() const
{
return RimWellPlotTools::hasFlowData(this);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::updateFilePathsFromProjectPath(const QString& newProjectPath, const QString& oldProjectPath)
{
bool foundFile = false;
std::vector<QString> searchedPaths;
QString fileNameCandidate = RimTools::relocateFile(m_fileName(), newProjectPath, oldProjectPath, &foundFile, &searchedPaths);
if (foundFile)
{
m_fileName = fileNameCandidate;
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<std::pair<double, double>> RimWellLogFile::findMdAndChannelValuesForWellPath(const RimWellPath* wellPath, const QString& channelName)
{
CVF_ASSERT(wellPath);
std::vector<RimWellLogFile*> wellLogFiles;
wellPath->descendantsIncludingThisOfType(wellLogFiles);
for (RimWellLogFile* wellLogFile : wellLogFiles)
{
RigWellLogFile* fileData = wellLogFile->wellLogFileData();
std::vector<double> channelValues = fileData->values(channelName);
if (!channelValues.empty())
{
std::vector<double> depthValues = fileData->depthValues();
CVF_ASSERT(depthValues.size() == channelValues.size());
std::vector<std::pair<double, double>> depthValuePairs;
for (size_t i = 0; i < depthValues.size(); ++i)
{
depthValuePairs.push_back(std::make_pair(depthValues[i], channelValues[i]));
}
return depthValuePairs;
}
}
return std::vector<std::pair<double, double>>();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::setupBeforeSave()
{
m_wellFlowCondition.xmlCapability()->setIOWritable(hasFlowData());
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
{
uiOrdering.add(&m_fileName);
uiOrdering.add(&m_date);
m_date.uiCapability()->setUiReadOnly(m_lasFileHasValidDate);
if (!isDateValid(m_date()))
{
uiOrdering.add(&m_invalidDateMessage);
}
if (hasFlowData())
{
uiOrdering.add(&m_wellFlowCondition);
}
uiOrdering.skipRemainingFields(true);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue)
{
if (changedField == &m_date)
{
// Due to a possible bug in QDateEdit/PdmUiDateEditor, convert m_date to a QDateTime having UTC timespec
m_date = RiaQDateTimeTools::createUtcDateTime(m_date().date(), m_date().time());
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimWellLogFile::defineEditorAttribute(const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute)
{
caf::PdmUiDateEditorAttribute* attrib = dynamic_cast<caf::PdmUiDateEditorAttribute*> (attribute);
if (attrib != nullptr)
{
attrib->dateFormat = RimTools::dateFormatString();
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
bool RimWellLogFile::isDateValid(const QDateTime dateTime)
{
return dateTime.isValid() && dateTime != DEFAULT_DATE_TIME;
}