OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
98aef167f600252afa8a5b9aa6990bb1bc88326d
ResInsight/scripting/commandfile/index.html
Magne Sjaastad 98aef167f6 Update formulas for FG_SHALE og SH Matthews and Kelly
2020-05-04 07:11:37 +02:00

4534 lines
82 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Hugo 0.65.3" />
<meta name="description" content="">
<link rel="icon" href="/images/favicon.png" type="image/png">
<title>Command File :: ResInsight</title>
<link href="/css/nucleus.css?1588568942" rel="stylesheet">
<link href="/css/fontawesome-all.min.css?1588568942" rel="stylesheet">
<link href="/css/hybrid.css?1588568942" rel="stylesheet">
<link href="/css/featherlight.min.css?1588568942" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1588568942" rel="stylesheet">
<link href="/css/auto-complete.css?1588568942" rel="stylesheet">
<link href="/css/atom-one-dark-reasonable.css?1588568942" rel="stylesheet">
<link href="/css/theme.css?1588568942" rel="stylesheet">
<link href="/css/hugo-theme.css?1588568942" rel="stylesheet">
<script src="/js/jquery-3.3.1.min.js?1588568942"></script>
<style>
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
</style>
<script type="text/javascript" async
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']],
displayMath: [['$$','$$'], ['\\[','\\]']],
processEscapes: true,
processEnvironments: true,
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
TeX: { equationNumbers: { autoNumber: "AMS" },
extensions: ["AMSmath.js", "AMSsymbols.js"] }
}
});
MathJax.Hub.Queue(function() {
var all = MathJax.Hub.getAllJax();
while(jax = all.pop()) {
jax.SourceElement().parentNode.className += ' has-jax';
}
});
MathJax.Hub.Config({
TeX: { equationNumbers: { autoNumber: "AMS" } }
});
</script>
</head>
<body class="" data-url="/scripting/commandfile/">
<nav id="sidebar" class="">
<div id="header-wrapper">
<div id="header">
<a id="logo" href="https://resinsight.org/">
<img src="https://resinsight.org//images/ResInsightCroppedIconPicture.png">
</a>
</div>
<div class="searchbox">
<label for="searchbox"><i class="fas fa-search"></i></label>
<form action="/search/" method="GET" id="search-form">
<input type="search" name="q" id="searchbox" placeholder="Search">
</form>
<span data-search-clear=""><i class="fas fa-times"></i></span>
</div>
</div>
<div class="highlightable">
<ul class="topics">
<li data-nav-id="/getting-started/" title="Getting Started" class="dd-item
">
<a href="/getting-started/">
Getting Started
</a>
<ul>
<li data-nav-id="/getting-started/overview/" title="Overview" class="dd-item ">
<a href="/getting-started/overview/">
Overview
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/" title="Download and Install" class="dd-item
">
<a href="/getting-started/download-and-install/">
Download and Install
</a>
<ul>
<li data-nav-id="/getting-started/download-and-install/linux-installation/" title="Linux Installation" class="dd-item ">
<a href="/getting-started/download-and-install/linux-installation/">
Linux Installation
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/windows-installation/" title="Windows Installation" class="dd-item ">
<a href="/getting-started/download-and-install/windows-installation/">
Windows Installation
</a>
</li>
<li data-nav-id="/getting-started/download-and-install/buildinstructions/" title="Build Instructions" class="dd-item ">
<a href="/getting-started/download-and-install/buildinstructions/">
Build Instructions
</a>
</li>
</ul>
</li>
<li data-nav-id="/getting-started/helpmenuanddocumentation/" title="Help Menu and Documentation" class="dd-item ">
<a href="/getting-started/helpmenuanddocumentation/">
Help Menu and Documentation
</a>
</li>
<li data-nav-id="/getting-started/modelnavigation/" title="Model Navigation" class="dd-item ">
<a href="/getting-started/modelnavigation/">
Model Navigation
</a>
</li>
<li data-nav-id="/getting-started/other/" title="Other" class="dd-item
">
<a href="/getting-started/other/">
Other
</a>
<ul>
<li data-nav-id="/getting-started/other/releasenotification/" title="Release Notification Subscription" class="dd-item ">
<a href="/getting-started/other/releasenotification/">
Release Notification Subscription
</a>
</li>
<li data-nav-id="/getting-started/other/testimonials/" title="Testimonials" class="dd-item ">
<a href="/getting-started/other/testimonials/">
Testimonials
</a>
</li>
</ul>
</li>
</ul>
</li>
<li data-nav-id="/3d-main-window/" title="3D Main Window" class="dd-item
">
<a href="/3d-main-window/">
3D Main Window
</a>
<ul>
<li data-nav-id="/3d-main-window/3dviews/" title="3D Views" class="dd-item ">
<a href="/3d-main-window/3dviews/">
3D Views
</a>
</li>
<li data-nav-id="/3d-main-window/cellresults/" title="Cell Results" class="dd-item ">
<a href="/3d-main-window/cellresults/">
Cell Results
</a>
</li>
<li data-nav-id="/3d-main-window/resultcolorlegend/" title="Result Color Legend" class="dd-item ">
<a href="/3d-main-window/resultcolorlegend/">
Result Color Legend
</a>
</li>
<li data-nav-id="/3d-main-window/comparisonview/" title="Comparison View" class="dd-item ">
<a href="/3d-main-window/comparisonview/">
Comparison View
</a>
</li>
<li data-nav-id="/3d-main-window/contourmaps/" title="Contour Maps" class="dd-item ">
<a href="/3d-main-window/contourmaps/">
Contour Maps
</a>
</li>
<li data-nav-id="/3d-main-window/tensors/" title="Tensor Results" class="dd-item ">
<a href="/3d-main-window/tensors/">
Tensor Results
</a>
</li>
<li data-nav-id="/3d-main-window/resultinspection/" title="Result Inspection" class="dd-item ">
<a href="/3d-main-window/resultinspection/">
Result Inspection
</a>
</li>
<li data-nav-id="/3d-main-window/filters/" title="Cell Filters" class="dd-item ">
<a href="/3d-main-window/filters/">
Cell Filters
</a>
</li>
<li data-nav-id="/3d-main-window/intersections/" title="Intersections" class="dd-item ">
<a href="/3d-main-window/intersections/">
Intersections
</a>
</li>
<li data-nav-id="/3d-main-window/surfaces/" title="Surfaces" class="dd-item ">
<a href="/3d-main-window/surfaces/">
Surfaces
</a>
</li>
<li data-nav-id="/3d-main-window/allandiagrams/" title="Allan Diagram" class="dd-item ">
<a href="/3d-main-window/allandiagrams/">
Allan Diagram
</a>
</li>
<li data-nav-id="/3d-main-window/faults/" title="Faults" class="dd-item ">
<a href="/3d-main-window/faults/">
Faults
</a>
</li>
<li data-nav-id="/3d-main-window/formations/" title=" Zonations/Formations" class="dd-item ">
<a href="/3d-main-window/formations/">
Zonations/Formations
</a>
</li>
<li data-nav-id="/3d-main-window/gridstatisticsdialog/" title="Grid Statistics Dialog" class="dd-item ">
<a href="/3d-main-window/gridstatisticsdialog/">
Grid Statistics Dialog
</a>
</li>
<li data-nav-id="/3d-main-window/casegroupsandstatistics/" title="Grid Case Groups and Statistics" class="dd-item ">
<a href="/3d-main-window/casegroupsandstatistics/">
Grid Case Groups and Statistics
</a>
</li>
<li data-nav-id="/3d-main-window/linkedviews/" title="Linked Views" class="dd-item ">
<a href="/3d-main-window/linkedviews/">
Linked Views
</a>
</li>
<li data-nav-id="/3d-main-window/measurement/" title="Measurement" class="dd-item ">
<a href="/3d-main-window/measurement/">
Measurement
</a>
</li>
<li data-nav-id="/3d-main-window/annotations/" title="Annotations" class="dd-item ">
<a href="/3d-main-window/annotations/">
Annotations
</a>
</li>
<li data-nav-id="/3d-main-window/derivedresults/" title="Derived Results" class="dd-item ">
<a href="/3d-main-window/derivedresults/">
Derived Results
</a>
</li>
</ul>
</li>
<li data-nav-id="/plot-window/" title="Plot Main Window" class="dd-item
">
<a href="/plot-window/">
Plot Main Window
</a>
<ul>
<li data-nav-id="/plot-window/summaryplots/" title="Summary Plots" class="dd-item ">
<a href="/plot-window/summaryplots/">
Summary Plots
</a>
</li>
<li data-nav-id="/plot-window/summarysourcestepping/" title="Summary Plot Source Stepping" class="dd-item ">
<a href="/plot-window/summarysourcestepping/">
Summary Plot Source Stepping
</a>
</li>
<li data-nav-id="/plot-window/summaryploteditor/" title="Summary Plot Editor" class="dd-item ">
<a href="/plot-window/summaryploteditor/">
Summary Plot Editor
</a>
</li>
<li data-nav-id="/plot-window/summarycrossplots/" title="Summary Cross Plot" class="dd-item ">
<a href="/plot-window/summarycrossplots/">
Summary Cross Plot
</a>
</li>
<li data-nav-id="/plot-window/summaryplottemplate/" title="Summary Plot Template" class="dd-item ">
<a href="/plot-window/summaryplottemplate/">
Summary Plot Template
</a>
</li>
<li data-nav-id="/plot-window/multiplots/" title="Multi Plots" class="dd-item ">
<a href="/plot-window/multiplots/">
Multi Plots
</a>
</li>
<li data-nav-id="/plot-window/ensembleplotting/" title="Ensemble Plotting" class="dd-item ">
<a href="/plot-window/ensembleplotting/">
Ensemble Plotting
</a>
</li>
<li data-nav-id="/plot-window/curvecalculator/" title="Curve Calculator" class="dd-item ">
<a href="/plot-window/curvecalculator/">
Curve Calculator
</a>
</li>
<li data-nav-id="/plot-window/welllogsandplots/" title="Well Log Plots" class="dd-item ">
<a href="/plot-window/welllogsandplots/">
Well Log Plots
</a>
</li>
<li data-nav-id="/plot-window/wellborestabilityplots/" title="Well Bore Stability Plots" class="dd-item ">
<a href="/plot-window/wellborestabilityplots/">
Well Bore Stability Plots
</a>
</li>
<li data-nav-id="/plot-window/rftplot/" title="RFT Plot" class="dd-item ">
<a href="/plot-window/rftplot/">
RFT Plot
</a>
</li>
<li data-nav-id="/plot-window/ensemblerftplot/" title="Ensemble RFT Plot" class="dd-item ">
<a href="/plot-window/ensemblerftplot/">
Ensemble RFT Plot
</a>
</li>
<li data-nav-id="/plot-window/pltplot/" title="PLT Plot" class="dd-item ">
<a href="/plot-window/pltplot/">
PLT Plot
</a>
</li>
<li data-nav-id="/plot-window/flowdiagnosticsplots/" title="Flow Diagnostics Plots" class="dd-item ">
<a href="/plot-window/flowdiagnosticsplots/">
Flow Diagnostics Plots
</a>
</li>
<li data-nav-id="/plot-window/gridcrossplots/" title="Grid Cross Plots" class="dd-item ">
<a href="/plot-window/gridcrossplots/">
Grid Cross Plots
</a>
</li>
<li data-nav-id="/plot-window/saturationpressureplots/" title="Saturation Pressure Plots" class="dd-item ">
<a href="/plot-window/saturationpressureplots/">
Saturation Pressure Plots
</a>
</li>
</ul>
</li>
<li data-nav-id="/wells-and-completions/" title="Wells and Completions" class="dd-item
">
<a href="/wells-and-completions/">
Wells and Completions
</a>
<ul>
<li data-nav-id="/wells-and-completions/simulationwells/" title="Simulation Wells" class="dd-item ">
<a href="/wells-and-completions/simulationwells/">
Simulation Wells
</a>
</li>
<li data-nav-id="/wells-and-completions/wellpaths/" title="Well Paths" class="dd-item ">
<a href="/wells-and-completions/wellpaths/">
Well Paths
</a>
</li>
<li data-nav-id="/wells-and-completions/createnewwellpaths/" title="Create Well Paths" class="dd-item ">
<a href="/wells-and-completions/createnewwellpaths/">
Create Well Paths
</a>
</li>
<li data-nav-id="/wells-and-completions/3dwelllogcurves/" title="3D Well Log Plots" class="dd-item ">
<a href="/wells-and-completions/3dwelllogcurves/">
3D Well Log Plots
</a>
</li>
<li data-nav-id="/wells-and-completions/completions/" title="Completions" class="dd-item ">
<a href="/wells-and-completions/completions/">
Completions
</a>
</li>
<li data-nav-id="/wells-and-completions/completionslgr/" title="Completions LGR" class="dd-item ">
<a href="/wells-and-completions/completionslgr/">
Completions LGR
</a>
</li>
<li data-nav-id="/wells-and-completions/wellmeasurements/" title="Well Measurements" class="dd-item ">
<a href="/wells-and-completions/wellmeasurements/">
Well Measurements
</a>
</li>
</ul>
</li>
<li data-nav-id="/import/" title="Import" class="dd-item
">
<a href="/import/">
Import
</a>
<ul>
<li data-nav-id="/import/eclipsecases/" title="Eclipse Cases" class="dd-item ">
<a href="/import/eclipsecases/">
Eclipse Cases
</a>
</li>
<li data-nav-id="/import/lasfile/" title="Log ASCII Standard File" class="dd-item ">
<a href="/import/lasfile/">
Log ASCII Standard File
</a>
</li>
<li data-nav-id="/import/geomechanicaldata/" title="Geomechanical Data" class="dd-item ">
<a href="/import/geomechanicaldata/">
Geomechanical Data
</a>
</li>
<li data-nav-id="/import/soursimrlresults/" title="SourSimRL Results" class="dd-item ">
<a href="/import/soursimrlresults/">
SourSimRL Results
</a>
</li>
<li data-nav-id="/import/elementpropertytable/" title="Element Property Table" class="dd-item ">
<a href="/import/elementpropertytable/">
Element Property Table
</a>
</li>
<li data-nav-id="/import/observeddata/" title="Observed Time History Data" class="dd-item ">
<a href="/import/observeddata/">
Observed Time History Data
</a>
</li>
<li data-nav-id="/import/pasteexceltimedata/" title="Paste Excel Time History Data" class="dd-item ">
<a href="/import/pasteexceltimedata/">
Paste Excel Time History Data
</a>
</li>
</ul>
</li>
<li data-nav-id="/export/" title="Export" class="dd-item
">
<a href="/export/">
Export
</a>
<ul>
<li data-nav-id="/export/snapshots/" title="Snapshots" class="dd-item ">
<a href="/export/snapshots/">
Snapshots
</a>
</li>
<li data-nav-id="/export/eclipseproperties/" title="Eclipse Properties" class="dd-item ">
<a href="/export/eclipseproperties/">
Eclipse Properties
</a>
</li>
<li data-nav-id="/export/fluxnummultnum/" title="FLUXNUM/MULTNUM" class="dd-item ">
<a href="/export/fluxnummultnum/">
FLUXNUM/MULTNUM
</a>
</li>
<li data-nav-id="/export/completionexport/" title="Completions" class="dd-item ">
<a href="/export/completionexport/">
Completions
</a>
</li>
<li data-nav-id="/export/exportwellpaths/" title="Well Paths" class="dd-item ">
<a href="/export/exportwellpaths/">
Well Paths
</a>
</li>
<li data-nav-id="/export/sectormodel/" title="Sector Model" class="dd-item ">
<a href="/export/sectormodel/">
Sector Model
</a>
</li>
<li data-nav-id="/export/contourmapexport/" title="Contour Map Export" class="dd-item ">
<a href="/export/contourmapexport/">
Contour Map Export
</a>
</li>
</ul>
</li>
<li data-nav-id="/scripting/" title="Scripting" class="dd-item
parent
">
<a href="/scripting/">
Scripting
</a>
<ul>
<li data-nav-id="/scripting/pythoninterface/" title="Python interface" class="dd-item ">
<a href="/scripting/pythoninterface/">
Python interface
</a>
</li>
<li data-nav-id="/scripting/commandlineinterface/" title="Command Line Interface" class="dd-item ">
<a href="/scripting/commandlineinterface/">
Command Line Interface
</a>
</li>
<li data-nav-id="/scripting/commandfile/" title="Command File" class="dd-item active">
<a href="/scripting/commandfile/">
Command File
</a>
</li>
<li data-nav-id="/scripting/octaveinterface/" title="Octave Interface" class="dd-item ">
<a href="/scripting/octaveinterface/">
Octave Interface
</a>
</li>
<li data-nav-id="/scripting/octaveinterfacereference/" title="Octave Interface Reference" class="dd-item ">
<a href="/scripting/octaveinterfacereference/">
Octave Interface Reference
</a>
</li>
</ul>
</li>
<li data-nav-id="/misc/" title="Miscellaneous" class="dd-item
">
<a href="/misc/">
Miscellaneous
</a>
<ul>
<li data-nav-id="/misc/preferences/" title="Preferences" class="dd-item ">
<a href="/misc/preferences/">
Preferences
</a>
</li>
<li data-nav-id="/misc/projectfile/" title="Project File and Caching" class="dd-item ">
<a href="/misc/projectfile/">
Project File and Caching
</a>
</li>
<li data-nav-id="/misc/memorymanagement/" title="Memory Management" class="dd-item ">
<a href="/misc/memorymanagement/">
Memory Management
</a>
</li>
<li data-nav-id="/misc/keyboardshortcuts/" title="Keyboard Shortcuts" class="dd-item ">
<a href="/misc/keyboardshortcuts/">
Keyboard Shortcuts
</a>
</li>
<li data-nav-id="/misc/regressiontestsystem/" title="Regression Test System" class="dd-item ">
<a href="/misc/regressiontestsystem/">
Regression Test System
</a>
</li>
</ul>
</li>
</ul>
<section id="shortcuts">
<h3></h3>
<ul>
<li>
<a class="padding" href="https://resinsight.org/about"><i class='fas fa-info-circle'></i> About</a>
</li>
<li>
<a class="padding" href="https://resinsight.org/support"><i class='far fa-question-circle'></i> Support</a>
</li>
<li>
<a class="padding" href="https://resinsight.org/getting-started/download-and-install"><i class='fas fa-download'></i> Download and Install</a>
</li>
</ul>
</section>
<section id="footer">
<a href="https://www.ceetronsolutions.com"><img src='https://resinsight.org//images/CeeSolLogoSmallForDarkBackground.png' style='width: 140px; '></a><br>
ResInsight is developed by <br> <a href="https://www.ceetronsolutions.com">Ceetron Solutions</a>
<p>in collaboration with</p>
<a href="https://www.equinor.com">Equinor ASA</a>
<script type="application/javascript">
var doNotTrack = false;
if (!doNotTrack) {
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-79509181-1', 'auto');
ga('send', 'pageview');
}
</script>
</section>
</div>
</nav>
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div>
<div id="top-bar">
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
<i class="fas fa-bars"></i>
</a>
</span>
<span id="toc-menu"><i class="fas fa-list-alt"></i></span>
<span class="links">
<a href='/'>ResInsight</a> > <a href='/scripting/'>Scripting</a> > Command File
</span>
</div>
<div class="progress">
<div class="wrapper">
<nav id="TableOfContents">
<ul>
<li>
<ul>
<li><a href="#command-list">Command List</a>
<ul>
<li></li>
</ul>
</li>
<li><a href="#syntax">Syntax</a>
<ul>
<li><a href="#types">Types</a></li>
</ul>
</li>
<li><a href="#case-control-commands-1">Case Control Commands</a>
<ul>
<li><a href="#openproject">openProject</a></li>
<li><a href="#closeproject">closeProject</a></li>
<li><a href="#setstartdir">setStartDir</a></li>
<li><a href="#loadcase">loadCase</a></li>
<li><a href="#creategridcasegroup">createGridCaseGroup</a></li>
<li><a href="#createstatisticscase">createStatisticsCase</a></li>
<li><a href="#replacecase">replaceCase</a></li>
<li><a href="#replacesourcecases">replaceSourceCases</a></li>
</ul>
</li>
<li><a href="#export-commands-1">Export Commands</a>
<ul>
<li><a href="#exportmulticasesnapshots">exportMultiCaseSnapshots</a></li>
<li><a href="#exportsnapshots">exportSnapshots</a></li>
<li><a href="#exportproperty">exportProperty</a></li>
<li><a href="#exportpropertyinviews">exportPropertyInViews</a></li>
<li><a href="#exportwellpathcompletions">exportWellPathCompletions</a></li>
<li><a href="#exportsimwellfracturecompletions">exportSimWellFractureCompletions</a></li>
<li><a href="#exportmsw">exportMsw</a></li>
<li><a href="#exportwellpaths">exportWellPaths</a></li>
<li><a href="#exportvisiblecells">exportVisibleCells</a></li>
<li><a href="#exportflowcharacteristics">exportFlowCharacteristics</a></li>
<li><a href="#setexportfolder">setExportFolder</a></li>
</ul>
</li>
<li><a href="#other">Other</a>
<ul>
<li><a href="#runoctavescript">runOctaveScript</a></li>
<li><a href="#setmainwindowsize">setMainWindowSize</a></li>
<li><a href="#computecasegroupstatistics">computeCaseGroupStatistics</a></li>
<li><a href="#settimestep">setTimeStep</a></li>
<li><a href="#scalefracturetemplate">scaleFractureTemplate</a></li>
<li><a href="#setfracturecontainment">setFractureContainment</a></li>
<li><a href="#createmultiplefractures">createMultipleFractures</a></li>
<li><a href="#createlgrforcompletions">createLgrForCompletions</a></li>
<li><a href="#createsaturationpressureplots">createSaturationPressurePlots</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="head-tags">
</div>
<div id="body-inner">
<h1>
Command File
</h1>
<p>The command file interface allows a sequence of specified commands to be run in order from the command line.
The interface is used by supplying the command file as a <a href="/scripting/commandlineinterface/">command line parameter</a>.
Once the command file is finished executing, ResInsight will exit.</p>
<p>It is possible to use these commands directly from a Python script. For further details, please see
the <a href="https://api.resinsight.org">ResInsight Python API</a>.</p>
<h2 id="command-list">Command List</h2>
<h4 id="case-control-commands">Case Control Commands</h4>
<ul>
<li><a href="#openproject">openProject</a></li>
<li><a href="#closeproject">closeProject</a></li>
<li><a href="#setstartdir">setStartDir</a></li>
<li><a href="#loadcase">loadCase</a></li>
<li><a href="#creategridcasegroup">createGridCaseGroup</a></li>
<li><a href="#createstatisticscase">createStatisticsCase</a></li>
<li><a href="#replacecase">replaceCase</a></li>
<li><a href="#replacesourcecases">replaceSourceCases</a></li>
</ul>
<h4 id="export-commands">Export Commands</h4>
<ul>
<li><a href="#setexportfolder">setExportFolder</a></li>
<li><a href="#exportmulticasesnapshots">exportMultiCaseSnapshots</a></li>
<li><a href="#exportsnapshots">exportSnapshots</a></li>
<li><a href="#exportproperty">exportProperty</a></li>
<li><a href="#exportpropertyinviews">exportPropertyInViews</a></li>
<li><a href="#exportwellpathcompletions">exportWellPathCompletions</a></li>
<li><a href="#exportsimwellfracturecompletions">exportSimWellFractureCompletions</a></li>
<li><a href="#exportmsw">exportMsw</a></li>
<li><a href="#exportwellpaths">exportWellPaths</a></li>
<li><a href="#exportvisiblecells">exportVisibleCells</a></li>
<li><a href="#exportflowcharacteristics">exportFlowCharacteristics</a></li>
</ul>
<h4 id="other-commands">Other Commands</h4>
<ul>
<li><a href="#runoctavescript">runOctaveScript</a></li>
<li><a href="#setmainwindowsize">setMainWindowSize</a></li>
<li><a href="#computecasegroupstatistics">computeCaseGroupStatistics</a></li>
<li><a href="#settimestep">setTimeStep</a></li>
<li><a href="#scalefracturetemplate">scaleFractureTemplate</a></li>
<li><a href="#setfracturecontainment">setFractureContainment</a></li>
<li><a href="#createmultiplefractures">createMultipleFractures</a></li>
<li><a href="#createlgrforcompletions">createLgrForCompletions</a></li>
<li><a href="#createSaturationPressurePlots">createSaturationPressurePlots</a></li>
</ul>
<h2 id="syntax">Syntax</h2>
<p>The command file is comprised of a set of commands to be executed in order. Each command must begin on a separate line, i.e. there cannot be two commands on the same line.</p>
<p>The line starts with the command name, followed by parenthesis. Within the parenthesis, parameters can be supplied. Each parameter must be named, followed by an equals sign and its value.</p>
<p>As an example; <code>openProject(path=&quot;/path/to/ResInsightProject.rsp&quot;)</code> will execute the command <code>openProject</code> with the parameter <code>path</code>. <code>path</code> is a string, see <a href="#types">Types</a> for a list of all types a parameter can have.</p>
<p>Not all parameters are required, in which case they can be omitted and their value will be defaulted. The order of parameters does not matter.</p>
<pre><code>Command file examples are displayed in sections like this.
</code></pre><h3 id="types">Types</h3>
<p>There are different types of parameters that can be supplied.</p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Input</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>Integer</td>
<td>Number</td>
<td>5</td>
</tr>
<tr>
<td>Double</td>
<td>Decimal number</td>
<td>3.14</td>
</tr>
<tr>
<td>String</td>
<td>Sequence of characters contained in quotes (<code>&quot;&quot;</code>)<sup>1</sup></td>
<td>&ldquo;/path/to/file&rdquo;</td>
</tr>
<tr>
<td>Enum</td>
<td>Choice of a set of given options</td>
<td>ALL</td>
</tr>
<tr>
<td>Boolean</td>
<td><code>true</code> or <code>false</code></td>
<td>true</td>
</tr>
<tr>
<td>List</td>
<td>Multiple choices of another type, written within square brackets (<code>[]</code>) separated by a comma (<code>,</code>)</td>
<td>[1, 2, 3]</td>
</tr>
</tbody>
</table>
<p><sup>1</sup> The backslash (<code>\</code>) character is used as an escape character within strings, so to use a quote within a string, use <code>&quot;escape \&quot; with \&quot;&quot;</code>. To input a literal backslash character, use <code>&quot;\\&quot;</code>.</p>
<h2 id="case-control-commands-1">Case Control Commands</h2>
<h3 id="openproject">openProject</h3>
<p>Opens a ResInsight project file.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>path</td>
<td>File path to the project file</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>openProject(path=&quot;/home/user/ResInsightProject.rsp&quot;)
</code></pre><h3 id="closeproject">closeProject</h3>
<p>Closes the current open project.</p>
<pre><code>closeProject()
</code></pre><h3 id="setstartdir">setStartDir</h3>
<p>Set startup directory.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>path</td>
<td>Path to directory to use as startup directory</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>setStartDir(path=&quot;/home/user&quot;)
</code></pre><h3 id="loadcase">loadCase</h3>
<p>Import Eclipse case from file.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>path</td>
<td>File path to the case to load</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>loadCase(path=&quot;/home/user/reservoir.EGRID&quot;)
</code></pre><h3 id="creategridcasegroup">createGridCaseGroup</h3>
<p>Create a Grid Case Group from a list of files.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>casePaths</td>
<td>List of Paths to Case Files</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<h3 id="createstatisticscase">createStatisticsCase</h3>
<p>Create a Statistics Case in a Grid Case Group.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseGroupId</td>
<td>ID to the Case Group</td>
<td>Integer</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>createGridCaseGroup(path=[&quot;/home/user/reservoir.EGRID&quot;, &quot;/home/user/other_reservoir.EGRID&quot;])
createStatisticsCase(caseGroupId=0)
</code></pre><h3 id="replacecase">replaceCase</h3>
<p>Replaces a case in the current project with the specified new case.</p>
<p><code>openProject</code> must be called before this command to set which project file is to be used when replacing cases. This command re-opens the project with the new case replaced. To replace more than one case at the same time, use <code>replaceSourceCases</code>.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>newGridFile</td>
<td>File path to the new grid file to replace with</td>
<td>String</td>
<td>✔</td>
</tr>
<tr>
<td>caseId</td>
<td>ID of the case to replace. Defaults to first case</td>
<td>Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>replaceCase(newGridFile=&quot;/home/user/otherReservoir.EGRID&quot;, caseId=4)
</code></pre><h3 id="replacesourcecases">replaceSourceCases</h3>
<p>Replaces multiple source cases in the current project.</p>
<p><code>openProject</code> must be called before this command to set which project file is to be used when replacing cases. This command re-opens tje project with the cases replaced.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>gridListFile</td>
<td>File path to file containing list of cases to replace with</td>
<td>String</td>
<td>✔</td>
</tr>
<tr>
<td>caseGroupId</td>
<td>ID of group to replace cases in. Defaults to first group</td>
<td>Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>replaceSourceCases(gridListFile=&quot;C:/resinsight/replacement_files.txt&quot;)
</code></pre><h2 id="export-commands-1">Export Commands</h2>
<h3 id="exportmulticasesnapshots">exportMultiCaseSnapshots</h3>
<p>Replaces the first case in the current project with each case in the given file and saves snapshots of all views.</p>
<p><code>openProject</code> must be called before this command to set which project file is to be used when replacing cases.</p>
<p>Folder to output snapshots should be set using <code>setExportFolder</code> with <code>SNAPSHOTS</code> type.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>gridListFile</td>
<td>File path to file containing list of cases to create snapshots of</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>exportMultiCaseSnapshots(gridListFile=&quot;C:\\resinsight\\replacement_files.txt&quot;)
</code></pre><h3 id="exportsnapshots">exportSnapshots</h3>
<p>Export snapshots of specified type.</p>
<p>Folder to output snapshots should be set using <code>setExportFolder</code> with <code>SNAPSHOTS</code> type.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>Type of snapshots to export. Choices: <code>ALL</code>, <code>VIEWS</code>, <code>PLOTS</code>. Defaults to <code>ALL</code></td>
<td>Enum</td>
<td></td>
</tr>
<tr>
<td>prefix</td>
<td>Exported file name prefix. Defaults to no prefix</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>caseId</td>
<td>ID of case for export, defaults to -1 meaning all cases</td>
<td>Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportSnapshots(type=PLOTS)
</code></pre><h3 id="exportproperty">exportProperty</h3>
<p>Exports property values for all cells in the grid to file in Eclipse format.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case for export</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>timeStep</td>
<td>The time step index for export</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>property</td>
<td>Name of property to export</td>
<td>String</td>
<td>✔</td>
</tr>
<tr>
<td>eclipseKeyword</td>
<td>Eclipse keyword used as text in export header. Defaults to the value of <code>property</code> parameter</td>
<td>String</td>
<td></td>
</tr>
<tr>
<td>undefinedValue</td>
<td>Value to use for undefined values. Defaults to 0.0</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>exportFile</td>
<td>Filename for export. Defaults to the value of <code>property</code> parameter</td>
<td>String</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportProperty(caseId=1, timeStep=4, property=&quot;SOIL&quot;)
</code></pre><h3 id="exportpropertyinviews">exportPropertyInViews</h3>
<p>Exports property values for all cells in the grid to file in Eclipse format. Use specified cell result in view to define the export property. One file per view will be exported.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to export property from</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>viewNames</td>
<td>Name of views to export from. If not specified, all views are exported</td>
<td>List of String</td>
<td></td>
</tr>
<tr>
<td>undefinedValue</td>
<td>Value to use for undefined values. Defaults to 0.0</td>
<td>Double</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportPropertyInViews(caseId=1)
exportPropertyInViews(caseId=1, viewNames=[&quot;view A&quot;, &quot;view 4&quot;])
</code></pre><h3 id="exportwellpathcompletions">exportWellPathCompletions</h3>
<p>Export well path completions.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to export well paths for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>timeStep</td>
<td>The time step to export completions for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>wellPathNames</td>
<td>Names of well paths to export for. Defaults to all checked wells. If a list of well names are provided, those wells are included even if unchecked</td>
<td>List of String</td>
<td></td>
</tr>
<tr>
<td>fileSplit</td>
<td>How the files are split. Choices: <code>UNIFIED_FILE</code>, <code>SPLIT_ON_WELL</code>, <code>SPLIT_ON_WELL_AND_COMPLETION_TYPE</code>. Defaults to <code>SPLIT_ON_WELL_AND_COMPLETION_TYPE</code></td>
<td>Enum</td>
<td></td>
</tr>
<tr>
<td>compdatExport</td>
<td>Chose whether transmissibilities are exported. Choices: <code>TRANSMISSIBILITIES</code>, <code>WPIMULT_AND_DEFAULT_CONNECTION_FACTORS</code>. Defaults to <code>TRANSMISSIBILITIES</code></td>
<td>Enum</td>
<td></td>
</tr>
<tr>
<td>includePerforations</td>
<td>Whether main bore perforations should be included. Defaults to <code>true</code></td>
<td>Boolean</td>
<td></td>
</tr>
<tr>
<td>includeFishbones</td>
<td>Whether fishbones should be included. Defaults to <code>true</code></td>
<td>Boolean</td>
<td></td>
</tr>
<tr>
<td>excludeMainBoreForFishbones</td>
<td>Whether main bore completions should be excluded for cells with fishbones. Defaults to <code>false</code></td>
<td>Boolean</td>
<td></td>
</tr>
<tr>
<td>combinationMode</td>
<td>Combination mode. Choices: <code>INDIVIDUALLY</code>, <code>COMBINED</code>. Defaults to <code>INDIVIDUALLY</code></td>
<td>Enum</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportWellPathCompletions(caseId=3, timeStep=5, includeFishbones=false)
</code></pre><h3 id="exportsimwellfracturecompletions">exportSimWellFractureCompletions</h3>
<p>Export fracture completions for simulation wells.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to export simulation well fracture completions for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>viewName</td>
<td>The name of the view to export simulation well fracture completions for. Since view names are not unique, all views sharing the given name will be used</td>
<td>String</td>
<td>✔</td>
</tr>
<tr>
<td>timeStep</td>
<td>The time step to export completions for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>simulationWellNames</td>
<td>Names of simulation wells to export for. Defaults to all checked wells. If a list of names are provided, those wells are included even if unchecked</td>
<td>List of String</td>
<td></td>
</tr>
<tr>
<td>fileSplit</td>
<td>How the files are split. Choices: <code>UNIFIED_FILE</code>, <code>SPLIT_ON_WELL</code>, <code>SPLIT_ON_WELL_AND_COMPLETION_TYPE</code>. Defaults to <code>UNIFIED_FILE</code></td>
<td>Enum</td>
<td></td>
</tr>
<tr>
<td>compdatExport</td>
<td>Chose whether transmissibilities are exported. Choices: <code>TRANSMISSIBILITIES</code>, <code>WPIMULT_AND_DEFAULT_CONNECTION_FACTORS</code>. Defaults to <code>TRANSMISSIBILITIES</code></td>
<td>Enum</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportSimWellFractureCompletions(caseId=3, viewName=&quot;View 2&quot;, timeStep=5)
</code></pre><h3 id="exportmsw">exportMsw</h3>
<p>Export multi-segment wells.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to export well paths for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>wellPath</td>
<td>Name of well path to export well segments for</td>
<td>String</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>exportMsw(caseId=1, wellPath=&quot;MainWell&quot;)
</code></pre><h3 id="exportwellpaths">exportWellPaths</h3>
<p>Export well paths.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>wellPathNames</td>
<td>Names of well paths to export for. Defaults to all checked wells. If a list of well names are provided, those wells are included even if unchecked</td>
<td>List of String</td>
<td></td>
</tr>
<tr>
<td>mdStepSize</td>
<td>Spacing (measured depth) between each sample along the well path. Default to 5.0</td>
<td>Double</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportWellPaths(wellPathNames=[&quot;B-1H&quot;, &quot;B-2H&quot;], mdStepSize=1.5)
</code></pre><h3 id="exportvisiblecells">exportVisibleCells</h3>
<p>Export visible cells</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to export cells for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>viewName</td>
<td>Name of the view associated with the specified case</td>
<td>Double</td>
<td>✔</td>
</tr>
<tr>
<td>exportKeyword</td>
<td>The keyword to export. Choices: <code>FLUXNUM</code> or <code>MULTNUM</code>. Default: <code>FLUXNUM</code></td>
<td>Enum</td>
<td></td>
</tr>
<tr>
<td>visibleActiveCellsValue</td>
<td>Value to use for visible active cells. Default: 1</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>hiddenActiveCellsValue</td>
<td>Value to use for hidden active cells. Default: 0</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>inactiveCellsValue</td>
<td>Value to use for inactive cells. Default: 0</td>
<td>Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exporVisibleCells(caseId=0, viewName=&quot;View 1&quot;, exportKeyword=MULTNUM)
</code></pre><h3 id="exportflowcharacteristics">exportFlowCharacteristics</h3>
<p>Export Flow Characteristics data to text file in CSV format</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>timeSteps</td>
<td>Time step indices</td>
<td>List of Integer</td>
<td>✔</td>
</tr>
<tr>
<td>injectors</td>
<td>Injector names</td>
<td>List of Strings</td>
<td></td>
</tr>
<tr>
<td>producers</td>
<td>Producer names</td>
<td>List of Strings</td>
<td></td>
</tr>
<tr>
<td>fileName</td>
<td>Export file name</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>minimumCommunication</td>
<td>Minimum Communication, defaults to 0.0</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>aquiferCellThreshold</td>
<td>Aquifer Cell Threshold, defaults to 0.1</td>
<td>Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>exportFlowCharacteristics(caseId=0, timeSteps=[1, 5, 6], injectors=[&quot;INJA&quot;, &quot;INJB&quot;], producers=[&quot;PROD_F&quot;], fileName=&quot;myData.csv&quot;)
</code></pre><h3 id="setexportfolder">setExportFolder</h3>
<p>Set the folder to export different types of data to. Set this before attempting to export data to ensure it is exported to desired location.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>Type of export folder to set. Choices: <code>COMPLETIONS</code>, <code>SNAPSHOTS</code>, <code>PROPERTIES</code>, <code>STATISTICS</code></td>
<td>Enum</td>
<td>✔</td>
</tr>
<tr>
<td>path</td>
<td>Directory to export the given type to</td>
<td>String</td>
<td>✔</td>
</tr>
<tr>
<td>createFolder</td>
<td>If true, create the folder when required. Default false.</td>
<td>Boolean</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>setExportFolder(type=SNAPSHOTS, path=&quot;/home/user/snapshots&quot;)
</code></pre><h2 id="other">Other</h2>
<h3 id="runoctavescript">runOctaveScript</h3>
<p>Execute an Octave script.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>path</td>
<td>Path to the octave script to execute</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>caseIds</td>
<td>The cases to run the octave script on. Defaults to running the script without a specified case</td>
<td>List of Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>runOctaveScript(path=&quot;/home/user/octave/something.m&quot;, caseIds=[1,2,6])
</code></pre><h3 id="setmainwindowsize">setMainWindowSize</h3>
<p>Resize the main window to the specified size.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>width</td>
<td>The width to set for the main window</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>height</td>
<td>The height to set for the main window</td>
<td>Integer</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>setMainWindowSize(width=1920, height=1200)
</code></pre><h3 id="computecasegroupstatistics">computeCaseGroupStatistics</h3>
<p>Compute statistics for statistics cases.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseIds</td>
<td>IDs of statistics cases to compute. Default is all statistics cases</td>
<td>List of Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>computeCaseGroupStatistics(caseIds=[5])
computeCaseGroupStatistics(caseIds=[2,4,8])
</code></pre><h3 id="settimestep">setTimeStep</h3>
<p>Set the time step for a given case. The time step is used for all views on the case.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to set time step for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>timeStep</td>
<td>Index of time step to switch to</td>
<td>Integer</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>setTimeStep(caseId=1, timeStep=8)
</code></pre><h3 id="scalefracturetemplate">scaleFractureTemplate</h3>
<p>Scale fracture template parameters.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>ID of fracture template</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>halfLength</td>
<td>Half Length scale factor</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>height</td>
<td>Height scale factor</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>dFactor</td>
<td>D-factor scale factor</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>conductivity</td>
<td>Conductivity scale factor</td>
<td>Double</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>scaleFractureTemplate(id=1, width=2, height=1.5)
</code></pre><h3 id="setfracturecontainment">setFractureContainment</h3>
<p>Set fracture template containment parameters.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>ID of fracture template</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>topLayer</td>
<td>Top layer containment</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>baseLayer</td>
<td>Base layer containment</td>
<td>Integer</td>
<td>✔</td>
</tr>
</tbody>
</table>
<pre><code>setFractureContainment(id=1, topLayer=2, baseLayer=7)
</code></pre><h3 id="createmultiplefractures">createMultipleFractures</h3>
<p>Create multiple fractures on one or more well paths.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>Case ID</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>templateId</td>
<td>Fracture template id</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>wellPathNames</td>
<td>Well path names. Default: All well paths</td>
<td>List of Strings</td>
<td></td>
</tr>
<tr>
<td>minDistFromWellTd</td>
<td>Min distance from well path tip. Default: 100.0 m</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>maxFracturesPerWell</td>
<td>Max fractures per well. Default: 100</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>topLayer</td>
<td>Top K layer. Default: Top layer from current model</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>baseLayer</td>
<td>Base K layer. Default: Bottom layer from current model</td>
<td>Integer</td>
<td></td>
</tr>
<tr>
<td>spacing</td>
<td>Distance between fractures. Default: 300.0 m</td>
<td>Double</td>
<td></td>
</tr>
<tr>
<td>action</td>
<td>How to handle existing fractures. Choices: <code>APPEND_FRACTURES</code>, <code>REPLACE_FRACTURES</code>. The replace option will delete all existing fractures before adding new ones. Default: <code>APPEND_FRACTURES</code></td>
<td>Enum</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>createMultipleFractures(caseId=0, templateId=1, wellPathNames=[&quot;B-1H&quot;, &quot;B-2H&quot;], action=REPLACE_FRACTURES)
</code></pre><h3 id="createlgrforcompletions">createLgrForCompletions</h3>
<p>Create temporary LGRs for completions on the selected well paths. The splitType parameter controls which main grid cells to split into LGRs. The LGR_PER_CELL option splits only those main grid cells that intersect with a completion. The LGR_PER_COMPLETION option splits all main grid cells that are located within an IJK bounding box covering all intersected cells for each completion. The LGR_PER_WELL works like the previous option, but the bounding box covers intersected cells for all completions on a well path.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseId</td>
<td>ID of case to create LGRs for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>timeStep</td>
<td>The time step to create LGRs for</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>wellPathNames</td>
<td>Names of well paths to export for. Defaults to all checked wells. If a list of well names are provided, those wells are included even if unchecked</td>
<td>List of String</td>
<td></td>
</tr>
<tr>
<td>refinementI</td>
<td>Size of the LGR along the I axis, in each main grid cell.</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>refinementJ</td>
<td>Size of the LGR along the J axis, in each main grid cell.</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>refinementK</td>
<td>Size of the LGR along the K axis, in each main grid cell.</td>
<td>Integer</td>
<td>✔</td>
</tr>
<tr>
<td>splitType</td>
<td>How to split the LGRs. Options: <code>LGR_PER_CELL</code>, <code>LGR_PER_COMPLETION</code>, <code>LGR_PER_WELL</code>. Default option is <code>LGR_PER_COMPLETION</code></td>
<td>Enum</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>createLgrForCompletions(caseId=0, timeStep=0, wellPathNames=[&quot;B-1H&quot;, &quot;B-2H&quot;], refinementI=2, refinementJ=3, refinementK=4, splitType=LGR_PER_WELL)
</code></pre><h3 id="createsaturationpressureplots">createSaturationPressurePlots</h3>
<p>Create saturation pressure plots for the specified cases.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Type</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>caseIds</td>
<td>IDs of cases to create plots for. Default is all cases</td>
<td>List of Integer</td>
<td></td>
</tr>
</tbody>
</table>
<pre><code>createSaturationPressurePlots(caseIds=[0])
</code></pre>
<footer class="footline">
</footer>
</div>
</div>
<div id="navigation">
<a class="nav nav-prev" href="/scripting/commandlineinterface/" title="Command Line Interface"> <i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href="/scripting/octaveinterface/" title="Octave Interface" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
</div>
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="/js/clipboard.min.js?1588568942"></script>
<script src="/js/perfect-scrollbar.min.js?1588568942"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1588568942"></script>
<script src="/js/jquery.sticky.js?1588568942"></script>
<script src="/js/featherlight.min.js?1588568942"></script>
<script src="/js/highlight.pack.js?1588568942"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom-3.6.0.js?1588568942"></script>
<script src="/js/learn.js?1588568942"></script>
<script src="/js/hugo-learn.js?1588568942"></script>
<link href="/mermaid/mermaid.css?1588568942" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1588568942"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink