<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
		<link type="text/css" rel="stylesheet" href="doxygen.css"/>
		<link type="text/css" rel="stylesheet" href="tabs.css"/>
	</head>
	<body>
	<div>
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">How to Run the Program </div>  </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#how_to_run_input">How to give Input - General Rules</a><ul><li class="level2"><a href="#how_to_run_organization">Organization of Input Data</a></li>
<li class="level2"><a href="#how_to_run_formats">Formats</a><ul><li class="level3"><a href="#how_to_run_comments">Comments</a></li>
<li class="level3"><a href="#how_to_run_alphanumeric_data">Alphanumeric Data Items</a></li>
<li class="level3"><a href="#how_to_run_integer_data">Integer Data Items (denoted integer)</a></li>
<li class="level3"><a href="#how_to_run_real_number_data">Real Number Data Items (denoted real)</a></li>
<li class="level3"><a href="#how_to_run_default_data_items">Default Data Items</a></li>
<li class="level3"><a href="#how_to_run_continuation_of">Continuation of Input Statements</a></li>
<li class="level3"><a href="#how_to_run_the_input_description">The Input Description List</a></li>
<li class="level3"><a href="#how_to_run_data-group_identifier">Data group Identifier</a></li>
</ul>
</li>
</ul>
</li>
<li class="level1"><a href="#how_to_run_standard">How to run RIFLEX with the riflex.bat batch file</a></li>
<li class="level1"><a href="#how_to_run_bash">How to run RIFLEX with the bash script vrr</a></li>
<li class="level1"><a href="#how_to_run_references">References</a></li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="how_to_run_input"></a>
How to give Input - General Rules</h1>
<h2><a class="anchor" id="how_to_run_organization"></a>
Organization of Input Data</h2>
<p>The input data are organized in groups, each group starting with a data group identifier, and terminating on the next data group identifier.</p>
<p>A data group identifier may consist of one, two or three words, which give a unique description of the data group. Each word may consist of several characters, but only the first four characters of each word are checked. The user may, of course, write the words completely to increase readability.</p>
<p>In this manual each input line is presented within a standard list, and each list represents either one single input line or a sequence of similar input lines. The input description list is presented in <a class="el" href="a00008.html#how_to_run_the_input_description">The Input Description List</a>.</p>
<h2><a class="anchor" id="how_to_run_formats"></a>
Formats</h2>
<p>Nearly all input data are read by FREAD /1/, a FORTRAN free-format reader and decoder. This means that the data items may be written anywhere on the input line, as long as the specified order is satisfied. The data items must be separated by at least one blank (exceeding blanks are ignored). Note that since blank is exclusively interpreted as a delimiter, blank can not be used to specify a zero value.</p>
<p>The line length is currently limited to 260 characters. Note that a RIFLEX input line may be split into several lines on the input file, see <a class="el" href="a00008.html#how_to_run_continuation_of">Continuation of Input Statements</a>.</p>
<h3>Important:</h3>
<p>All digits, letters and/or special symbols in a data item must be given consecutively without blanks.</p>
<h3><a class="anchor" id="how_to_run_comments"></a>
Comments</h3>
<p>Input lines with an apostrophe (<code>'</code>) in the first column are interpreted as comments, and simply ignored. Comments may be inserted anywhere in the input data stream in order to improve the readability of the input data.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line"><span class="stringliteral">&#39;THIS IS A COMMENT</span></div>
<div class="line"><span class="stringliteral">&#39;</span>NOTE! COMMENTS ARE IGNORED BY THE PROGRAM</div>
</div><!-- fragment --><h3><a class="anchor" id="how_to_run_alphanumeric_data"></a>
Alphanumeric Data Items</h3>
<p>In this manual, alphanumeric data items are denoted as character with a maxim length given in parentheses; e. g. character(8) which has a maximum length of 8. If the input item is longer than the maximum length, all characters in excess of this are simply ignored.</p>
<p>An alphanumeric data item may consist of one or more characters. The first character is always a letter (A-Z), while the remaining ones may be letters, digits or special symbols (except /, $, &amp; and blank).</p>
<h4>Example:</h4>
<div class="fragment"><div class="line"><span class="stringliteral">&#39;WITH CHARACTER(4)</span></div>
<div class="line"><span class="stringliteral">ENVIRONMENTAL DATA</span></div>
<div class="line"><span class="stringliteral">&#39;</span>WILL BE INTERPRETED AS</div>
<div class="line">ENVI DATA</div>
<div class="line"><span class="stringliteral">&#39;WITH CHARACTER(6)</span></div>
<div class="line"><span class="stringliteral">ENVIRONMENTAL DATA</span></div>
<div class="line"><span class="stringliteral">&#39;</span>WILL BE INTERPRETED AS</div>
<div class="line">ENVIRO DATA</div>
</div><!-- fragment --><p>When file names are input, the maximum length of the file name is given in the manual.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line">CHFTRA</div>
</div><!-- fragment --><ul>
<li><code>CHFTRA: character(80)</code>: File name with transfer functions data</li>
</ul>
<p>It is recommended that the combined length of the path and file name does not exceed 256 characters.</p>
<h3><a class="anchor" id="how_to_run_integer_data"></a>
Integer Data Items (denoted integer)</h3>
<p>All characters must be digits. The first digit may be preceded by a + or a - character.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line">0 1 -27 +66</div>
</div><!-- fragment --><h3><a class="anchor" id="how_to_run_real_number_data"></a>
Real Number Data Items (denoted real)</h3>
<p>A real number data entry may consist of up to 3 components, i.e. an integer part i, a decimal part d, and exponent part e. The following 4 basic forms are accepted:</p>
<p><code>(+)i (+)i. (+)i.d (+).d</code></p>
<p>These may all be combined with exponent parts yielding the forms:</p>
<p><code>(+)iE(+)e (+)i.E(+)e (+)i.dE(+)e (+).dE(+)e</code></p>
<h4>Example:</h4>
<div class="fragment"><div class="line">0 -1. -0.2E14 +17.E-3 1.78E+3</div>
</div><!-- fragment --><h3><a class="anchor" id="how_to_run_default_data_items"></a>
Default Data Items</h3>
<p>Some of the input data have default values, that is, values to be inserted when no other values are given. There are two ways to signal that the program shall insert default values. One, that may always be used, is to type a slash (/) for the actual data item. Second, if the actual data item (or data items) is (are) the last one(s) on the input line, no slash(es) is (are) necessary. FREAD will insert the number of slashes needed. Note that the slash is also a data item, and must be separated from adjacent data items by one or more blanks.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line"><span class="stringliteral">&#39;THE DEFAULT VALUE OF THE SECOND DATA ITEM IS 2. THEN</span></div>
<div class="line"><span class="stringliteral">3 / 5</span></div>
<div class="line"><span class="stringliteral">&#39;</span>WILL BE INTERPRETED AS</div>
<div class="line">3 2 5</div>
<div class="line"><span class="stringliteral">&#39;6 DATA ITEMS ARE READ AND THE LAST 3 DATA ITEMS HAVE DEFAULT</span></div>
<div class="line"><span class="stringliteral">VALUES 6, 7 AND 8, THEN</span></div>
<div class="line"><span class="stringliteral">1 2 3</span></div>
<div class="line"><span class="stringliteral">&#39;</span>WILL BE INTERPRETED AS</div>
<div class="line">1 2 3 6 7 8</div>
</div><!-- fragment --><h3><a class="anchor" id="how_to_run_continuation_of"></a>
Continuation of Input Statements</h3>
<p>An input statement may consist of one or several input lines. If an input statement consists of more than one input line, all its input lines except the last one must be terminated by the character &amp;, which must be preceded by at least one blank. This implies that on such lines data cannot be specified beyond column 258.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line">1 2 &amp;</div>
<div class="line">3</div>
<div class="line"><span class="stringliteral">&#39;IS THE SAME AS GIVING</span></div>
<div class="line"><span class="stringliteral">1 2 3</span></div>
</div><!-- fragment --><h3><a class="anchor" id="how_to_run_the_input_description"></a>
The Input Description List</h3>
<div class="fragment"><div class="line">&lt;parameter names, in the order decoded&gt;</div>
</div><!-- fragment --><ul>
<li><code>Parameter: type, default: Default value</code>: Description <img class="formulaInl" alt="$ \mathrm{[unit]} $" src="form_28.png"/><ul>
<li>Optional additional information for the given parameter.</li>
</ul>
</li>
</ul>
<p>Comments, notes etc.</p>
<p>If there is no default value, that part of the line is skipped. The parameter types are integer, real and character.</p>
<p>If unit is not applicable, e.g. for integer options, that part of the line is skipped.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line">IKS DAMP</div>
</div><!-- fragment --><ul>
<li><code>IKS: integer</code>: Stiffness code 1<ul>
<li>1 : Constant spring compression stiffness</li>
<li>N : Table with N pairs of pressure force - displacements to be specified<ul>
<li>N &gt; 2</li>
</ul>
</li>
</ul>
</li>
<li><code>DAMP: real, default: 0</code>: Dash pot damping coefficient <img class="formulaInl" alt="$ \mathrm{[FT/L]}$" src="form_29.png"/></li>
</ul>
<h3><a class="anchor" id="how_to_run_data-group_identifier"></a>
Data group Identifier</h3>
<p>As mentioned in <a class="el" href="a00008.html#how_to_run_organization">Organization of Input Data</a>, the input data are organized in groups.</p>
<p>A data group identifier is given on the first input line of each group.</p>
<div class="fragment"><div class="line">IDW1 IDW2 IDW3</div>
</div><!-- fragment --><ul>
<li><code>IDW1: character(4)</code>: First word of the identifier</li>
<li><code>IDW2: character(4)</code>: Second word of the identifier</li>
<li><code>IDW3: character(4)</code>: Third word of the identifier</li>
</ul>
<p>Data group identifiers may consist of one, two or three words</p>
<p>In the input description, data group identifiers are not presented within the standard list, but the words of the identifiers are written completely in the code box above. With format character(4), only the first four characters are checked, and these parts of the words are marked.</p>
<h4>Example:</h4>
<div class="fragment"><div class="line">ROTAtion STIFfness CHARacteristics</div>
</div><!-- fragment --><p>may be given as</p>
<div class="fragment"><div class="line">ROTA STIF CHAR</div>
</div><!-- fragment --><h1><a class="anchor" id="how_to_run_standard"></a>
How to run RIFLEX with the riflex.bat batch file</h1>
<p>This section will give a description of how to run RIFLEX modules using the <code>riflex.bat</code> batch file delivered as a part of a <code>RIFLEX</code> installation. The <code>riflex.bat</code> file is used for running the batch oriented modules <code>INPMOD</code>, <code>STAMOD</code>, <code>DYNMOD</code> and <code>OUTMOD</code>.</p>
<p>The file name convention used consists of a prefix in addition to the basic file names described in <a class="el" href="a00002.html#introduction_explanation">Explanation of Files Used</a>. The prefix and the basic file names are separated by an underscore.</p>
<p>A common prefix may be used for all the files or two prefixes may be used; prefix1 for identification of <code>INPMOD</code> and <code>STAMOD</code> files and prefix2 for identification of <code>DYNMOD</code> and <code>OUTMOD</code> files. If prefix2 is not given, it will be set to prefix1.</p>
<p>The necessary commands to run <code>RIFLEX</code> modules <code>INPMOD</code>, <code>STAMOD</code>, <code>DYNMOD</code> and <code>OUTMOD</code> with a common prefix are:</p>
<div class="fragment"><div class="line">riflex inpmod prefix1</div>
<div class="line">riflex stamod prefix1</div>
<div class="line">riflex dynmod prefix1</div>
<div class="line">riflex outmod prefix1</div>
</div><!-- fragment --><p>or alternatively with two prefixes: </p>
<div class="fragment"><div class="line">riflex inpmod prefix1</div>
<div class="line">riflex stamod prefix1</div>
<div class="line">riflex dynmod prefix1 prefix2</div>
<div class="line">riflex outmod prefix1 prefix2</div>
</div><!-- fragment --><h1><a class="anchor" id="how_to_run_bash"></a>
How to run RIFLEX with the bash script vrr</h1>
<p>This section will give a description of how to run <code>RIFLEX</code> modules using the <code>vrr</code> bash script. Bash scripts may be run on Linux or Unix systems or in a bash shell under Windows; e.g. Git bash, Cygwin.</p>
<p>The <code>vrr</code> bash script is delivered as a part of a <code>RIFLEX</code> installation and may be used to run several modules in succession, stopping if errors are detected. The necessary command to run the <code>RIFLEX</code> modules <code>INPMOD</code>, <code>STAMOD</code>, <code>DYNMOD</code> and <code>OUTMOD</code> with a common prefix is:</p>
<div class="fragment"><div class="line">/full/path/to/Riflex/bin/vrr isdo prefix1</div>
</div><!-- fragment --><h1>RIFLEX files</h1>
<p>The file names used by the different modules are summarized in the following. For description of the files used for internal communication, see <a class="el" href="a00002.html#introduction_explanation">Explanation of Files Used</a>.</p>
<h2>INPMOD files:</h2>
<ul>
<li><code>prefix1_inpmod.inp</code> - ASCII input file</li>
<li><code>prefix1_inpmod.res</code> - ASCII result file</li>
</ul>
<ul>
<li><code>prefix1_ifninp.sam</code> - internal communication file</li>
</ul>
<h2>STAMOD files:</h2>
<ul>
<li><code>prefix1_stamod.inp</code> - ASCII input file</li>
<li><code>prefix1_stamod.res</code> - ASCII result file</li>
<li><code>prefix1_stamod.mpf</code> - ASCII file with key static results</li>
</ul>
<ul>
<li><code>prefix1_ifnsys.sam</code> - internal communication file</li>
<li><code>prefix1_ifnsta.ffi</code> - internal communication file</li>
<li><code>prefix1_ifndmp.sam</code> - internal communication file</li>
</ul>
<h2>DYNMOD files:</h2>
<ul>
<li><code>prefix2_dynmod.inp</code> - ASCII input file</li>
<li><code>prefix2_dynmod.res</code> - ASCII result file</li>
<li><code>prefix2_dynmod.mpf</code> - ASCII file with key dynamic results</li>
</ul>
<ul>
<li><code>prefix2_ifnirr.sam</code> - internal communication file</li>
<li><code>prefix2_ifndyn.ffi</code> - internal communication file</li>
<li><code>prefix2_ifndmp.sam</code> - internal communication file</li>
</ul>
<h2>OUTMOD files:</h2>
<ul>
<li><code>prefix2_outmod.inp</code> - ASCII input file</li>
<li><code>prefix2_outmod.res</code> - ASCII result file</li>
<li><code>prefix2_outmod.mpf</code> - ASCII file with some key <code>OUTMOD</code> results; e.g. stresses.</li>
<li><code>prefix2_ifnplo.ffi</code> - plot file, to be referred in <code>PLOMOD</code></li>
</ul>
<p>The user input is given on files with extension <code>.inp</code>, while key results can be found on files with extension <code>.res</code>.</p>
<h1><a class="anchor" id="how_to_run_references"></a>
References</h1>
<ol type="1">
<li>Adam, J et al. (1987): FREAD: A FORTRAN free format reader and decoder. SINTEF, Trondheim, Norway. </li>
</ol>
</div></div><!-- contents -->
	</body>
</html>