ResInsight/ApplicationCode/ProjectDataModel/RimIntersection.cpp
2017-04-25 10:31:56 +02:00

673 lines
22 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 "RimIntersection.h"
#include "RiaApplication.h"
#include "RigSimulationWellCenterLineCalculator.h"
#include "RigWellPath.h"
#include "RimCase.h"
#include "RimEclipseView.h"
#include "RimEclipseWell.h"
#include "RimEclipseWellCollection.h"
#include "RimOilField.h"
#include "RimProject.h"
#include "RimTools.h"
#include "RimView.h"
#include "RimWellPath.h"
#include "RiuViewer.h"
#include "RivIntersectionPartMgr.h"
#include "cafCmdFeature.h"
#include "cafCmdFeatureManager.h"
#include "cafPdmUiListEditor.h"
#include "cafPdmUiPushButtonEditor.h"
#include "cvfBoundingBox.h"
#include "cvfPlane.h"
namespace caf {
template<>
void caf::AppEnum< RimIntersection::CrossSectionEnum >::setUp()
{
addItem(RimIntersection::CS_WELL_PATH, "CS_WELL_PATH", "Well Path");
addItem(RimIntersection::CS_SIMULATION_WELL, "CS_SIMULATION_WELL", "Simulation Well");
addItem(RimIntersection::CS_POLYLINE, "CS_POLYLINE", "Polyline");
setDefault(RimIntersection::CS_WELL_PATH);
}
template<>
void caf::AppEnum< RimIntersection::CrossSectionDirEnum >::setUp()
{
addItem(RimIntersection::CS_VERTICAL, "CS_VERTICAL", "Vertical");
addItem(RimIntersection::CS_HORIZONTAL, "CS_HORIZONTAL", "Horizontal");
addItem(RimIntersection::CS_TWO_POINTS, "CS_TWO_POINTS", "Defined by two points");
setDefault(RimIntersection::CS_VERTICAL);
}
}
CAF_PDM_SOURCE_INIT(RimIntersection, "CrossSection");
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimIntersection::RimIntersection()
{
CAF_PDM_InitObject("Intersection", ":/CrossSection16x16.png", "", "");
CAF_PDM_InitField(&name, "UserDescription", QString("Intersection Name"), "Name", "", "", "");
CAF_PDM_InitField(&isActive, "Active", true, "Active", "", "", "");
isActive.uiCapability()->setUiHidden(true);
CAF_PDM_InitFieldNoDefault(&type, "Type", "Type", "", "", "");
CAF_PDM_InitFieldNoDefault(&direction, "Direction", "Direction", "", "", "");
CAF_PDM_InitFieldNoDefault(&wellPath, "WellPath", "Well Path ", "", "", "");
CAF_PDM_InitFieldNoDefault(&simulationWell, "SimulationWell", "Simulation Well", "", "", "");
CAF_PDM_InitFieldNoDefault(&m_userPolyline, "Points", "Points", "", "Use Ctrl-C for copy and Ctrl-V for paste", "");
CAF_PDM_InitFieldNoDefault(&m_customExtrusionPoints, "CustomExtrusionPoints", "", "", "", "");
CAF_PDM_InitField (&m_branchIndex, "Branch", -1, "Branch", "", "", "");
CAF_PDM_InitField (&m_extentLength, "ExtentLength", 200.0, "Extent length", "", "", "");
CAF_PDM_InitField (&showInactiveCells, "ShowInactiveCells", false, "Show Inactive Cells", "", "", "");
CAF_PDM_InitFieldNoDefault(&inputPolyLineFromViewerEnabled, "m_activateUiAppendPointsCommand", "", "", "", "");
inputPolyLineFromViewerEnabled.xmlCapability()->setIOWritable(false);
inputPolyLineFromViewerEnabled.xmlCapability()->setIOReadable(false);
inputPolyLineFromViewerEnabled.uiCapability()->setUiEditorTypeName(caf::PdmUiPushButtonEditor::uiEditorTypeName());
inputPolyLineFromViewerEnabled = false;
CAF_PDM_InitFieldNoDefault(&inputExtrusionPointsFromViewerEnabled, "inputExtrusionPointsFromViewerEnabled", "", "", "", "");
inputExtrusionPointsFromViewerEnabled.xmlCapability()->setIOWritable(false);
inputExtrusionPointsFromViewerEnabled.xmlCapability()->setIOReadable(false);
inputExtrusionPointsFromViewerEnabled.uiCapability()->setUiEditorTypeName(caf::PdmUiPushButtonEditor::uiEditorTypeName());
inputExtrusionPointsFromViewerEnabled = false;
uiCapability()->setUiTreeChildrenHidden(true);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimIntersection::~RimIntersection()
{
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue)
{
if (changedField == &isActive ||
changedField == &type ||
changedField == &direction ||
changedField == &wellPath ||
changedField == &simulationWell ||
changedField == &m_branchIndex ||
changedField == &m_extentLength ||
changedField == &showInactiveCells)
{
rebuildGeometryAndScheduleCreateDisplayModel();
}
if (changedField == &simulationWell
|| changedField == &isActive
|| changedField == &type)
{
m_wellBranchCenterlines.clear();
updateWellCenterline();
m_branchIndex = -1;
}
if (changedField == &simulationWell
|| changedField == &wellPath
|| changedField == &m_branchIndex)
{
updateName();
}
if (changedField == &inputPolyLineFromViewerEnabled
|| changedField == &m_userPolyline)
{
if (inputPolyLineFromViewerEnabled)
{
inputExtrusionPointsFromViewerEnabled = false;
}
rebuildGeometryAndScheduleCreateDisplayModel();
}
if (changedField == &inputExtrusionPointsFromViewerEnabled
|| changedField == &m_customExtrusionPoints)
{
if (inputExtrusionPointsFromViewerEnabled)
{
inputPolyLineFromViewerEnabled = false;
}
rebuildGeometryAndScheduleCreateDisplayModel();
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering)
{
uiOrdering.add(&name);
caf::PdmUiGroup* geometryGroup = uiOrdering.addNewGroup("Intersecting Geometry");
geometryGroup->add(&type);
if (type == CS_WELL_PATH)
{
geometryGroup->add(&wellPath);
}
else if (type == CS_SIMULATION_WELL)
{
geometryGroup->add(&simulationWell);
updateWellCenterline();
if (simulationWell() && m_wellBranchCenterlines.size() > 1)
{
geometryGroup->add(&m_branchIndex);
}
}
else if (type == CS_POLYLINE)
{
geometryGroup->add(&m_userPolyline);
geometryGroup->add(&inputPolyLineFromViewerEnabled);
}
caf::PdmUiGroup* optionsGroup = uiOrdering.addNewGroup("Options");
optionsGroup->add(&direction);
if (direction == CS_TWO_POINTS)
{
optionsGroup->add(&m_customExtrusionPoints);
optionsGroup->add(&inputExtrusionPointsFromViewerEnabled);
}
optionsGroup->add(&m_extentLength);
optionsGroup->add(&showInactiveCells);
if (type == CS_POLYLINE)
{
m_extentLength.uiCapability()->setUiReadOnly(true);
}
else
{
m_extentLength.uiCapability()->setUiReadOnly(false);
}
updateWellExtentDefaultValue();
uiOrdering.skipRemainingFields(true);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QList<caf::PdmOptionItemInfo> RimIntersection::calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool * useOptionsOnly)
{
QList<caf::PdmOptionItemInfo> options;
if (fieldNeedingOptions == &wellPath)
{
RimTools::wellPathOptionItems(&options);
if (options.size() > 0)
{
options.push_front(caf::PdmOptionItemInfo("None", nullptr));
}
}
else if (fieldNeedingOptions == &simulationWell)
{
RimEclipseWellCollection* coll = simulationWellCollection();
if (coll)
{
caf::PdmChildArrayField<RimEclipseWell*>& eclWells = coll->wells;
QIcon simWellIcon(":/Well.png");
for (RimEclipseWell* eclWell : eclWells)
{
options.push_back(caf::PdmOptionItemInfo(eclWell->name(), eclWell, false, simWellIcon));
}
}
if (options.size() == 0)
{
options.push_front(caf::PdmOptionItemInfo("None", nullptr));
}
}
else if (fieldNeedingOptions == &m_branchIndex)
{
updateWellCenterline();
size_t branchCount = m_wellBranchCenterlines.size();
options.push_back(caf::PdmOptionItemInfo("All", -1));
for (size_t bIdx = 0; bIdx < branchCount; ++bIdx)
{
options.push_back(caf::PdmOptionItemInfo(QString::number(bIdx + 1), QVariant::fromValue(bIdx)));
}
}
return options;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimIntersection::userDescriptionField()
{
return &name;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
caf::PdmFieldHandle* RimIntersection::objectToggleField()
{
return &isActive;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RimEclipseWellCollection* RimIntersection::simulationWellCollection()
{
RimEclipseView* eclipseView = NULL;
firstAncestorOrThisOfType(eclipseView);
if (eclipseView)
{
return eclipseView->wellCollection;
}
return NULL;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector< std::vector <cvf::Vec3d> > RimIntersection::polyLines() const
{
std::vector< std::vector <cvf::Vec3d> > lines;
if (type == CS_WELL_PATH)
{
if (wellPath())
{
lines.push_back(wellPath->wellPathGeometry()->m_wellPathPoints);
clipToReservoir(lines[0]);
}
}
else if (type == CS_SIMULATION_WELL)
{
if (simulationWell())
{
updateWellCenterline();
if (0 <= m_branchIndex && m_branchIndex < static_cast<int>(m_wellBranchCenterlines.size()))
{
lines.push_back(m_wellBranchCenterlines[m_branchIndex]);
}
if (m_branchIndex == -1)
{
lines = m_wellBranchCenterlines;
}
}
}
else if (type == CS_POLYLINE)
{
lines.push_back(m_userPolyline);
}
if (type == CS_WELL_PATH || type == CS_SIMULATION_WELL)
{
for (size_t lIdx = 0; lIdx < lines.size(); ++lIdx)
{
std::vector<cvf::Vec3d>& polyLine = lines[lIdx];
addExtents(polyLine);
}
}
return lines;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RivIntersectionPartMgr* RimIntersection::intersectionPartMgr()
{
if (m_crossSectionPartMgr.isNull()) m_crossSectionPartMgr = new RivIntersectionPartMgr(this);
return m_crossSectionPartMgr.p();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector< std::vector <cvf::Vec3d> > RimIntersection::polyLinesForExtrusionDirection() const
{
std::vector< std::vector <cvf::Vec3d> > lines;
lines.push_back(m_customExtrusionPoints);
return lines;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::updateWellCenterline() const
{
if (isActive() && type == CS_SIMULATION_WELL && simulationWell())
{
if (m_wellBranchCenterlines.size() == 0)
{
std::vector< std::vector <RigWellResultPoint> > pipeBranchesCellIds;
simulationWell->calculateWellPipeStaticCenterLine(m_wellBranchCenterlines, pipeBranchesCellIds);
}
}
else
{
m_wellBranchCenterlines.clear();
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::addExtents(std::vector<cvf::Vec3d> &polyLine) const
{
size_t lineVxCount = polyLine.size();
if (lineVxCount == 0) return;
// Add extent at end of well
{
size_t endIdxOffset = lineVxCount > 3 ? 3: lineVxCount;
cvf::Vec3d endDirection = (polyLine[lineVxCount-1] - polyLine[lineVxCount-endIdxOffset]);
endDirection[2] = 0; // Remove z. make extent lenght be horizontally
if (endDirection.length() < 1e-2)
{
endDirection = polyLine.back() - polyLine.front();
endDirection[2] = 0;
if (endDirection.length() < 1e-2)
{
endDirection = cvf::Vec3d::X_AXIS;
}
}
endDirection.normalize();
cvf::Vec3d newEnd = polyLine.back() + endDirection * m_extentLength();
polyLine.push_back(newEnd);
}
// Add extent at start
{
size_t endIdxOffset = lineVxCount > 3 ? 3: lineVxCount-1;
cvf::Vec3d startDirection = (polyLine[0] - polyLine[endIdxOffset]);
startDirection[2] = 0; // Remove z. make extent lenght be horizontally
if (startDirection.length() < 1e-2)
{
startDirection = polyLine.front() - polyLine.back();
startDirection[2] = 0;
if (startDirection.length() < 1e-2)
{
startDirection = -cvf::Vec3d::X_AXIS;
}
}
startDirection.normalize();
cvf::Vec3d newStart = polyLine.front() + startDirection * m_extentLength();
polyLine.insert(polyLine.begin(), newStart);
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::updateWellExtentDefaultValue()
{
RimCase* ownerCase = NULL;
firstAncestorOrThisOfType(ownerCase);
if (ownerCase)
{
cvf::BoundingBox caseBB = ownerCase->activeCellsBoundingBox();
if (m_extentLength == m_extentLength.defaultValue() && caseBB.radius() < 1000)
{
m_extentLength = caseBB.radius() * 0.1;
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::updateName()
{
if (type == CS_SIMULATION_WELL && simulationWell())
{
name = simulationWell()->name();
if (m_branchIndex() != -1)
{
name = name() + " Branch " + QString::number(m_branchIndex() + 1);
}
}
else if (type() == CS_WELL_PATH && wellPath())
{
name = wellPath()->name();
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::clipToReservoir(std::vector<cvf::Vec3d> &polyLine) const
{
RimCase* ownerCase = NULL;
firstAncestorOrThisOfType(ownerCase);
std::vector<cvf::Vec3d> clippedPolyLine;
if (ownerCase)
{
cvf::BoundingBox caseBB = ownerCase->activeCellsBoundingBox();
bool hasEnteredReservoirBB = false;
for (size_t vxIdx = 0 ; vxIdx < polyLine.size(); ++vxIdx)
{
if (!caseBB.contains(polyLine[vxIdx]))
{
continue;
}
if (!hasEnteredReservoirBB)
{
if (vxIdx > 0)
{
// clip line, and add vx to start
cvf::Plane topPlane;
topPlane.setFromPointAndNormal(caseBB.max(), cvf::Vec3d::Z_AXIS);
cvf::Vec3d intersection;
if (topPlane.intersect(polyLine[vxIdx-1], polyLine[vxIdx], &intersection))
{
clippedPolyLine.push_back(intersection);
}
}
hasEnteredReservoirBB = true;
}
clippedPolyLine.push_back(polyLine[vxIdx]);
}
}
polyLine.swap(clippedPolyLine);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::defineEditorAttribute(const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute)
{
if (field == &inputPolyLineFromViewerEnabled)
{
caf::PdmUiPushButtonEditorAttribute* attrib = dynamic_cast<caf::PdmUiPushButtonEditorAttribute*> (attribute);
if (attrib)
{
if (inputPolyLineFromViewerEnabled)
{
attrib->m_buttonText = "Stop picking points";
}
else
{
attrib->m_buttonText = "Start picking points";
}
}
}
else if (field == &m_userPolyline)
{
caf::PdmUiListEditorAttribute* myAttr = dynamic_cast<caf::PdmUiListEditorAttribute*>(attribute);
if (myAttr && inputPolyLineFromViewerEnabled)
{
myAttr->m_baseColor.setRgb(255, 220, 255);
}
}
else if (field == &inputExtrusionPointsFromViewerEnabled)
{
caf::PdmUiPushButtonEditorAttribute* attrib = dynamic_cast<caf::PdmUiPushButtonEditorAttribute*> (attribute);
if (attrib)
{
if (inputExtrusionPointsFromViewerEnabled)
{
attrib->m_buttonText = "Stop picking points";
}
else
{
attrib->m_buttonText = "Start picking points";
}
}
}
else if (field == &m_customExtrusionPoints)
{
caf::PdmUiListEditorAttribute* myAttr = dynamic_cast<caf::PdmUiListEditorAttribute*>(attribute);
if (myAttr && inputExtrusionPointsFromViewerEnabled)
{
myAttr->m_baseColor.setRgb(255, 220, 255);
}
}
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::appendPointToPolyLine(const cvf::Vec3d& point)
{
m_userPolyline.v().push_back(point);
m_userPolyline.uiCapability()->updateConnectedEditors();
rebuildGeometryAndScheduleCreateDisplayModel();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::appendPointToExtrusionDirection(const cvf::Vec3d& point)
{
if (m_customExtrusionPoints().size() > 1) m_customExtrusionPoints.v().clear();
m_customExtrusionPoints.v().push_back(point);
m_customExtrusionPoints.uiCapability()->updateConnectedEditors();
rebuildGeometryAndScheduleCreateDisplayModel();
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
cvf::Vec3d RimIntersection::extrusionDirection() const
{
cvf::Vec3d dir = cvf::Vec3d::Z_AXIS;
if (direction() == RimIntersection::CS_HORIZONTAL)
{
std::vector< std::vector <cvf::Vec3d> > lines = this->polyLines();
if (lines.size() > 0 && lines[0].size() > 1)
{
std::vector <cvf::Vec3d> firstLine = lines[0];
// Use first and last point of polyline to approximate orientation of polyline
// Then cross with Z axis to find extrusion direction
cvf::Vec3d polyLineDir = firstLine[firstLine.size() - 1] - firstLine[0];
cvf::Vec3d up = cvf::Vec3d::Z_AXIS;
dir = polyLineDir ^ up;
}
}
else if (direction() == RimIntersection::CS_TWO_POINTS && m_customExtrusionPoints().size() > 1)
{
dir = m_customExtrusionPoints()[m_customExtrusionPoints().size() - 1] - m_customExtrusionPoints()[0];
}
return dir;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void RimIntersection::rebuildGeometryAndScheduleCreateDisplayModel()
{
m_crossSectionPartMgr = NULL;
RimView* rimView = NULL;
this->firstAncestorOrThisOfType(rimView);
if (rimView)
{
rimView->scheduleCreateDisplayModelAndRedraw();
}
}