TUT: relocate externalCoupled heater tutorial, add steady-state version

tutorials/heatTransfer/chtMultiRegionSimpleFoam/externalCoupledHeater/externalSolver

@@ -0,0 +1,156 @@
+#!/bin/sh
+#
+# Dummy external solver to communicate with OpenFOAM via externalCoupled
+# functionObject
+#
+# Functionality is hard-coded for this particular test case
+# - patch temperatures increased by 1K on each step
+#
+cd ${0%/*} || exit 1    # Run from this directory
+
+# Check for unassigned variables
+set -u
+
+echo "Executing dummy external solver"
+
+commsDir="comms"
+patchDir="heater_topAir/coupleGroup"
+fieldName="T"
+
+lockFile="${commsDir}/OpenFOAM.lock"
+dataFile="${commsDir}/${patchDir}/${fieldName}"
+waitSec=5
+timeOut=100
+nSteps=1000 # maximum number of time steps. Note: should be more than
+            # number of iterations on the OpenFOAM side
+
+stopAt=300  # external solver signals OpenFOAM to stop
+
+refGrad=0
+valueFraction=1
+
+# Remove any old junk
+\rm -f $lockFile 2>/dev/null
+
+log()
+{
+    echo "External: $@"
+}
+
+
+# Create lock file to pass control to OpenFOAM
+useMaster()
+{
+    log "creating lock file '${lockFile}'"
+    echo "status=openfoam" >| ${lockFile}
+}
+
+# Lock file with special content to stop OpenFOAM master
+stopMasterNow()
+{
+    log "writeNow terminate via lock file '${lockFile}'"
+    echo "action=writeNow" >| ${lockFile}
+}
+
+
+init()
+{
+    log "init - creating ${dataFile}.in"
+    cat /dev/null >| "${dataFile}.in"
+
+    # Hard-coded for patch of size 8 (heater/minY)
+    local n1=8
+    local refValue1=500
+
+    log "init - adding $n1 data elements with refValue $refValue1"
+    for i in $(seq 1 $n1)
+    do
+        echo "$refValue1 $refGrad $valueFraction"
+    done >> "${dataFile}.in"
+
+    # Hard-coded for patch of size 40 (topAir/minX)
+    local n2=40
+    local refValue2=300
+    log "init - adding $n2 data elements with refValue $refValue2"
+    for i in $(seq 1 $n2)
+    do
+        echo "$refValue2 $refGrad $valueFraction"
+    done >> "${dataFile}.in"
+
+    # Verify line count?
+    # log "init ($(wc -l ${dataFile}.in))"
+
+    # Give time for T.in file to flush
+    sleep 1
+
+    useMaster
+}
+
+
+# Create the comms directory
+mkdir -p ${commsDir}/${patchDir}
+
+# Tutorial case uses 'initByExternal' option, so we must provide initial values
+init
+
+
+totalWait=0
+step=0
+while [ $step -lt $nSteps ]
+do
+    if [ -f $lockFile ]
+    then
+        if grep -q "status=done" ${lockFile}
+        then
+             log "found lock file '${lockFile}' with 'status=done' - finished"
+             break
+        elif [ -s $lockFile ]
+        then
+             log "found lock file '${lockFile}' containing '$(< $lockFile)' - waiting"
+        else
+             log "found lock file '${lockFile}' - waiting"
+        fi
+
+        totalWait=$(expr $totalWait + $waitSec)
+        if [ $totalWait -gt $timeOut ]
+        then
+            log "timeout"
+            break
+        else
+            sleep $waitSec
+        fi
+    else
+        totalWait=0
+        step=$(expr $step + 1)
+        log "step $step"
+        log "lock not present - taking control"
+
+        log "sleeping for $waitSec secs to simulate external process"
+        sleep $waitSec
+
+        log "updating ${dataFile}.in from ${dataFile}.out"
+
+        if [ -f "${dataFile}.out" ]
+        then
+            ##awk '{if( $1 != "#" ){print $1+0.1 " 0 1"}}' \
+            awk '{if( $1 != "#" ){print $1 " 0 1"}}' \
+                ${dataFile}.out >| ${dataFile}.in
+        else
+            log "Warning: no such file ${dataFile}.out"
+        fi
+
+        if [ "${stopAt:-0}" -eq $step ]
+        then
+            stopMasterNow
+        else
+            useMaster
+        fi
+    fi
+done
+
+log "done"
+
+# Remove the lock file too
+\rm -f $lockFile 2>/dev/null
+
+#------------------------------------------------------------------------------