./precice-tools md > reference.md

precice-configuration

Main tag containing preCICE configuration.

Example:

<precice-configuration experimental="0" wait-in-finalize="0">
  <log enabled="1">
    ...
  </log>
  <profiling flush-every="50" directory="." mode="fundamental" synchronize="0"/>
  <data:scalar waveform-degree="1" name="{string}"/>
  <mesh dimensions="{integer}" name="{string}">
    ...
  </mesh>
  <m2n:sockets port="0" acceptor="{string}" connector="{string}" exchange-directory="" network="lo" enforce-gather-scatter="0" use-two-level-initialization="0"/>
  <participant name="{string}">
    ...
  </participant>
  <coupling-scheme:serial-explicit>
    ...
  </coupling-scheme:serial-explicit>
</precice-configuration>

Valid Subtags:

• log 0..1
• profiling 0..1
• mesh 1..*
• participant 1..*
• coupling-scheme
  • serial-explicit 0..*
  • parallel-explicit 0..*
  • serial-implicit 0..*
  • parallel-implicit 0..*
  • multi 0..*
• data
  • scalar 0..*
  • vector 0..*
• m2n
  • sockets 0..*
  • mpi-multiple-ports 0..*
  • mpi 0..*

log

Configures logging sinks based on Boost log.

Example:

<log enabled="1">
  <sink filter="(%Severity% > debug) and not ((%Severity% = info) and (%Rank% != 0))" format="(%Rank%) %TimeStamp(format="%H:%M:%S")% [%Module%]:%Line% in %Function%: %ColorizedSeverity%%Message%" output="stdout" type="stream" enabled="1"/>
</log>

Valid Subtags:

• sink 0..*

sink

Contains the configuration of a single log sink, which allows fine grained control of what to log where. Available attributes in filter and format strings are %TimeStamp%, %Runtime%, %Severity%, %ColorizedSeverity%, %File%, %Line%, %Function%, %Module%, %Rank%, and %Participant%. The boolean attribute %preCICE% is true for all log entries originating from preCICE.

Example:

<sink filter="(%Severity% > debug) and not ((%Severity% = info) and (%Rank% != 0))" format="(%Rank%) %TimeStamp(format="%H:%M:%S")% [%Module%]:%Line% in %Function%: %ColorizedSeverity%%Message%" output="stdout" type="stream" enabled="1"/>

profiling

Allows configuring the profiling functionality of preCICE.

Example:

<profiling flush-every="50" directory="." mode="fundamental" synchronize="0"/>

data:scalar

Defines a scalar data set to be assigned to meshes.

Example:

<data:scalar waveform-degree="1" name="{string}"/>

data:vector

Defines a vector data set to be assigned to meshes. The number of components of each data entry depends on the spatial dimensions set in tag .

Example:

<data:vector waveform-degree="1" name="{string}"/>

mesh

Surface mesh consisting of vertices and optional connectivity information. The vertices of a mesh can carry data, configured by tags . The mesh coordinates have to be defined by a participant (see tag ).

Example:

<mesh dimensions="{integer}" name="{string}">
  <use-data name="{string}"/>
</mesh>

Valid Subtags:

• use-data 0..*

use-data

Assigns a before defined data set (see tag ) to the mesh.

Example:

<use-data name="{string}"/>

m2n:sockets

Communication via Sockets.

Example:

<m2n:sockets port="0" acceptor="{string}" connector="{string}" exchange-directory="" network="lo" enforce-gather-scatter="0" use-two-level-initialization="0"/>

m2n:mpi-multiple-ports

Communication via MPI with startup in separated communication spaces, using multiple communicators.

Example:

<m2n:mpi-multiple-ports acceptor="{string}" connector="{string}" exchange-directory="" enforce-gather-scatter="0" use-two-level-initialization="0"/>

m2n:mpi

Communication via MPI with startup in separated communication spaces, using a single communicator

Example:

<m2n:mpi acceptor="{string}" connector="{string}" exchange-directory="" enforce-gather-scatter="0" use-two-level-initialization="0"/>

participant

Represents one solver using preCICE. At least two participants have to be defined.

Example:

<participant name="{string}">
  <write-data mesh="{string}" name="{string}"/>
  <read-data mesh="{string}" name="{string}"/>
  <mapping:nearest-neighbor constraint="{string}" direction="{string}" from="{string}" to="{string}"/>
  <action:multiply-by-area mesh="{string}" timing="{string}">
    ...
  </action:multiply-by-area>
  <export:vtk every-n-time-windows="1" directory="" every-iteration="0"/>
  <watch-point mesh="{string}" name="{string}" coordinate="{vector}"/>
  <watch-integral mesh="{string}" name="{string}" scale-with-connectivity="{boolean}"/>
  <provide-mesh name="{string}"/>
  <receive-mesh safety-factor="0.5" from="{string}" geometric-filter="on-secondary-ranks" name="{string}" direct-access="0"/>
  <intra-comm:sockets port="0" exchange-directory="" network="lo"/>
</participant>

Valid Subtags:

• write-data 0..*
• read-data 0..*
• watch-point 0..*
• watch-integral 0..*
• provide-mesh 0..*
• receive-mesh 0..*
• action
  • multiply-by-area 0..*
  • divide-by-area 0..*
  • summation 0..*
  • recorder 0..*
  • python 0..*
• export
  • vtk 0..*
  • vtu 0..*
  • vtp 0..*
  • csv 0..*
• intra-comm
  • sockets 0..1
  • mpi 0..1
• mapping
  • nearest-neighbor 0..*
  • nearest-projection 0..*
  • nearest-neighbor-gradient 0..*
  • linear-cell-interpolation 0..*
  • rbf-global-iterative 0..*
  • rbf-global-direct 0..*
  • rbf-pum-direct 0..*
  • rbf 0..*
  • axial-geometric-multiscale 0..*
  • radial-geometric-multiscale 0..*

write-data

Sets data to be written by the participant to preCICE. Data is defined by using the tag.

Example:

<write-data mesh="{string}" name="{string}"/>

read-data

Sets data to be read by the participant from preCICE. Data is defined by using the tag.

Example:

<read-data mesh="{string}" name="{string}"/>

mapping:nearest-neighbor

Nearest-neighbour mapping which uses a rstar-spacial index tree to index meshes and run nearest-neighbour queries.

Example:

<mapping:nearest-neighbor constraint="{string}" direction="{string}" from="{string}" to="{string}"/>

mapping:nearest-projection

Nearest-projection mapping which uses a rstar-spacial index tree to index meshes and locate the nearest projections.

Example:

<mapping:nearest-projection constraint="{string}" direction="{string}" from="{string}" to="{string}"/>

mapping:nearest-neighbor-gradient

Nearest-neighbor-gradient mapping which uses nearest-neighbor mapping with an additional linear approximation using gradient data.

Example:

<mapping:nearest-neighbor-gradient constraint="{string}" direction="{string}" from="{string}" to="{string}"/>

mapping:linear-cell-interpolation

Linear cell interpolation mapping which uses a rstar-spacial index tree to index meshes and locate the nearest cell. Only supports 2D meshes.

Example:

<mapping:linear-cell-interpolation constraint="{string}" direction="{string}" from="{string}" to="{string}"/>

mapping:rbf-global-iterative

Radial-basis-function mapping using an iterative solver with a distributed parallelism.

Example:

<mapping:rbf-global-iterative solver-rtol="1e-09" constraint="{string}" direction="{string}" from="{string}" polynomial="separate" to="{string}" x-dead="0" y-dead="0" z-dead="0">
  <executor:cpu/>
  <basis-function:compact-polynomial-c0 support-radius="{float}"/>
</mapping:rbf-global-iterative>

Valid Subtags:

• basis-function
  • compact-polynomial-c0 0..1
  • compact-polynomial-c2 0..1
  • compact-polynomial-c4 0..1
  • compact-polynomial-c6 0..1
  • compact-polynomial-c8 0..1
  • compact-tps-c2 0..1
  • multiquadrics 0..1
  • inverse-multiquadrics 0..1
  • gaussian 0..1
  • thin-plate-splines 0..1
  • volume-splines 0..1
• executor
  • cpu 0..1
  • cuda 0..1
  • hip 0..1
  • openmp 0..1

executor:cpu

The default executor relying on PETSc, which uses CPUs and distributed memory parallelism via MPI.

Example:

<executor:cpu/>

executor:cuda

Cuda (Nvidia) executor, which uses Ginkgo with a gather-scatter parallelism.

Example:

<executor:cuda gpu-device-id="0"/>

executor:hip

Hip (AMD/Nvidia) executor, which uses hipSolver with a gather-scatter parallelism.

Example:

<executor:hip gpu-device-id="0"/>

executor:openmp

OpenMP executor, which uses Ginkgo with a gather-scatter parallelism.

Example:

<executor:openmp n-threads="0"/>

basis-function:compact-polynomial-c0

Wendland C0 function

Example:

<basis-function:compact-polynomial-c0 support-radius="{float}"/>

basis-function:compact-polynomial-c2

Wendland C2 function

Example:

<basis-function:compact-polynomial-c2 support-radius="{float}"/>

basis-function:compact-polynomial-c4

Wendland C4 function

Example:

<basis-function:compact-polynomial-c4 support-radius="{float}"/>

basis-function:compact-polynomial-c6

Wendland C6 function

Example:

<basis-function:compact-polynomial-c6 support-radius="{float}"/>

basis-function:compact-polynomial-c8

Wendland C8 function

Example:

<basis-function:compact-polynomial-c8 support-radius="{float}"/>

basis-function:compact-tps-c2

Compact thin-plate-spline C2

Example:

<basis-function:compact-tps-c2 support-radius="{float}"/>

basis-function:multiquadrics

Multiquadrics

Example:

<basis-function:multiquadrics shape-parameter="{float}"/>

basis-function:inverse-multiquadrics

Inverse multiquadrics

Example:

<basis-function:inverse-multiquadrics shape-parameter="{float}"/>

basis-function:gaussian

Gaussian basis function accepting a support radius or a shape parameter.

Example:

<basis-function:gaussian shape-parameter="nan" support-radius="nan"/>

basis-function:thin-plate-splines

Thin-plate-splines

Example:

<basis-function:thin-plate-splines/>

basis-function:volume-splines

Volume splines

Example:

<basis-function:volume-splines/>

mapping:rbf-global-direct

Radial-basis-function mapping using a direct solver with a gather-scatter parallelism.

Example:

<mapping:rbf-global-direct constraint="{string}" direction="{string}" from="{string}" polynomial="separate" to="{string}" x-dead="0" y-dead="0" z-dead="0">
  <executor:cpu/>
  <basis-function:compact-polynomial-c0 support-radius="{float}"/>
</mapping:rbf-global-direct>

Valid Subtags:

• basis-function
  • compact-polynomial-c0 0..1
  • compact-polynomial-c2 0..1
  • compact-polynomial-c4 0..1
  • compact-polynomial-c6 0..1
  • compact-polynomial-c8 0..1
  • compact-tps-c2 0..1
  • multiquadrics 0..1
  • inverse-multiquadrics 0..1
  • gaussian 0..1
  • thin-plate-splines 0..1
  • volume-splines 0..1
• executor
  • cpu 0..1
  • cuda 0..1
  • hip 0..1

executor:cpu

The default executor, which uses a single-core CPU with a gather-scatter parallelism.

Example:

<executor:cpu/>

executor:cuda

Cuda (Nvidia) executor, which uses cuSolver/Ginkgo and a direct QR decomposition with a gather-scatter parallelism.

Example:

<executor:cuda gpu-device-id="0"/>

executor:hip

Hip (AMD/Nvidia) executor, which uses hipSolver/Ginkgo and a direct QR decomposition with a gather-scatter parallelism.

Example:

<executor:hip gpu-device-id="0"/>

basis-function:compact-polynomial-c0

Wendland C0 function

Example:

<basis-function:compact-polynomial-c0 support-radius="{float}"/>

basis-function:compact-polynomial-c2

Wendland C2 function

Example:

<basis-function:compact-polynomial-c2 support-radius="{float}"/>

basis-function:compact-polynomial-c4

Wendland C4 function

Example:

<basis-function:compact-polynomial-c4 support-radius="{float}"/>

basis-function:compact-polynomial-c6

Wendland C6 function

Example:

<basis-function:compact-polynomial-c6 support-radius="{float}"/>

basis-function:compact-polynomial-c8

Wendland C8 function

Example:

<basis-function:compact-polynomial-c8 support-radius="{float}"/>

basis-function:compact-tps-c2

Compact thin-plate-spline C2

Example:

<basis-function:compact-tps-c2 support-radius="{float}"/>

basis-function:multiquadrics

Multiquadrics

Example:

<basis-function:multiquadrics shape-parameter="{float}"/>

basis-function:inverse-multiquadrics

Inverse multiquadrics

Example:

<basis-function:inverse-multiquadrics shape-parameter="{float}"/>

basis-function:gaussian

Gaussian basis function accepting a support radius or a shape parameter.

Example:

<basis-function:gaussian shape-parameter="nan" support-radius="nan"/>

basis-function:thin-plate-splines

Thin-plate-splines

Example:

<basis-function:thin-plate-splines/>

basis-function:volume-splines

Volume splines

Example:

<basis-function:volume-splines/>

mapping:rbf-pum-direct

Radial-basis-function mapping using a partition of unity method, which supports a distributed parallelism.

Example:

<mapping:rbf-pum-direct relative-overlap="0.15" vertices-per-cluster="50" constraint="{string}" direction="{string}" from="{string}" polynomial="separate" to="{string}" project-to-input="1">
  <executor:cpu/>
  <basis-function:compact-polynomial-c0 support-radius="{float}"/>
</mapping:rbf-pum-direct>

Valid Subtags:

• basis-function
  • compact-polynomial-c0 0..1
  • compact-polynomial-c2 0..1
  • compact-polynomial-c4 0..1
  • compact-polynomial-c6 0..1
  • compact-polynomial-c8 0..1
  • compact-tps-c2 0..1
  • multiquadrics 0..1
  • inverse-multiquadrics 0..1
  • gaussian 0..1
  • thin-plate-splines 0..1
  • volume-splines 0..1
• executor
  • cpu 0..1

executor:cpu

The default (and currently only) executor using a CPU and a distributed memory parallelism via MPI.

Example:

<executor:cpu/>

basis-function:compact-polynomial-c0

Wendland C0 function

Example:

<basis-function:compact-polynomial-c0 support-radius="{float}"/>

basis-function:compact-polynomial-c2

Wendland C2 function

Example:

<basis-function:compact-polynomial-c2 support-radius="{float}"/>

basis-function:compact-polynomial-c4

Wendland C4 function

Example:

<basis-function:compact-polynomial-c4 support-radius="{float}"/>

basis-function:compact-polynomial-c6

Wendland C6 function

Example:

<basis-function:compact-polynomial-c6 support-radius="{float}"/>

basis-function:compact-polynomial-c8

Wendland C8 function

Example:

<basis-function:compact-polynomial-c8 support-radius="{float}"/>

basis-function:compact-tps-c2

Compact thin-plate-spline C2

Example:

<basis-function:compact-tps-c2 support-radius="{float}"/>

basis-function:multiquadrics

Multiquadrics

Example:

<basis-function:multiquadrics shape-parameter="{float}"/>

basis-function:inverse-multiquadrics

Inverse multiquadrics

Example:

<basis-function:inverse-multiquadrics shape-parameter="{float}"/>

basis-function:gaussian

Gaussian basis function accepting a support radius or a shape parameter.

Example:

<basis-function:gaussian shape-parameter="nan" support-radius="nan"/>

basis-function:thin-plate-splines

Thin-plate-splines

Example:

<basis-function:thin-plate-splines/>

basis-function:volume-splines

Volume splines

Example:

<basis-function:volume-splines/>

mapping:rbf

Alias tag, which auto-selects a radial-basis-function mapping depending on the simulation parameter,

Example:

<mapping:rbf constraint="{string}" direction="{string}" from="{string}" to="{string}" x-dead="0" y-dead="0" z-dead="0">
  <basis-function:compact-polynomial-c0 support-radius="{float}"/>
</mapping:rbf>

Valid Subtags:

• basis-function
  • compact-polynomial-c0 0..1
  • compact-polynomial-c2 0..1
  • compact-polynomial-c4 0..1
  • compact-polynomial-c6 0..1
  • compact-polynomial-c8 0..1
  • compact-tps-c2 0..1
  • multiquadrics 0..1
  • inverse-multiquadrics 0..1
  • gaussian 0..1
  • thin-plate-splines 0..1
  • volume-splines 0..1

basis-function:compact-polynomial-c0

Wendland C0 function

Example:

<basis-function:compact-polynomial-c0 support-radius="{float}"/>

basis-function:compact-polynomial-c2

Wendland C2 function

Example:

<basis-function:compact-polynomial-c2 support-radius="{float}"/>

basis-function:compact-polynomial-c4

Wendland C4 function

Example:

<basis-function:compact-polynomial-c4 support-radius="{float}"/>

basis-function:compact-polynomial-c6

Wendland C6 function

Example:

<basis-function:compact-polynomial-c6 support-radius="{float}"/>

basis-function:compact-polynomial-c8

Wendland C8 function

Example:

<basis-function:compact-polynomial-c8 support-radius="{float}"/>

basis-function:compact-tps-c2

Compact thin-plate-spline C2

Example:

<basis-function:compact-tps-c2 support-radius="{float}"/>

basis-function:multiquadrics

Multiquadrics

Example:

<basis-function:multiquadrics shape-parameter="{float}"/>

basis-function:inverse-multiquadrics

Inverse multiquadrics

Example:

<basis-function:inverse-multiquadrics shape-parameter="{float}"/>

basis-function:gaussian

Gaussian basis function accepting a support radius or a shape parameter.

Example:

<basis-function:gaussian shape-parameter="nan" support-radius="nan"/>

basis-function:thin-plate-splines

Thin-plate-splines

Example:

<basis-function:thin-plate-splines/>

basis-function:volume-splines

Volume splines

Example:

<basis-function:volume-splines/>

mapping:axial-geometric-multiscale

Axial geometric multiscale mapping between one 1D and multiple 3D vertices.

Example:

<mapping:axial-geometric-multiscale multiscale-radius="{float}" constraint="{string}" direction="{string}" from="{string}" multiscale-axis="{string}" multiscale-type="{string}" to="{string}"/>

mapping:radial-geometric-multiscale

Radial geometric multiscale mapping between multiple 1D and multiple 3D vertices, distributed along a principle axis.

Example:

<mapping:radial-geometric-multiscale multiscale-radius="{float}" constraint="{string}" direction="{string}" from="{string}" multiscale-axis="{string}" multiscale-type="{string}" to="{string}"/>

action:multiply-by-area

Multiplies data values with mesh area associated to vertex holding the value.

Example:

<action:multiply-by-area mesh="{string}" timing="{string}">
  <target-data name="{string}"/>
</action:multiply-by-area>

Valid Subtags:

• target-data 1

target-data

Data to read from and write to.

Example:

<target-data name="{string}"/>

action:divide-by-area

Divides data values by mesh area associated to vertex holding the value.

Example:

<action:divide-by-area mesh="{string}" timing="{string}">
  <target-data name="{string}"/>
</action:divide-by-area>

Valid Subtags:

• target-data 1

target-data

Data to read from and write to.

Example:

<target-data name="{string}"/>

action:summation

Sums up multiple source data values and writes the result into target data.

Example:

<action:summation mesh="{string}" timing="{string}">
  <source-data name="{string}"/>
  <target-data name="{string}"/>
</action:summation>

Valid Subtags:

• source-data 1..*
• target-data 1

source-data

Multiple data to read from.

Example:

<source-data name="{string}"/>

target-data

Data to read from and write to.

Example:

<target-data name="{string}"/>

action:recorder

Records action invocations for testing purposes.

Example:

<action:recorder mesh="{string}" timing="{string}"/>

action:python

Calls Python script to execute action. See preCICE file “src/action/PythonAction.py” for an example.

Example:

<action:python mesh="{string}" timing="{string}">
  <path name=""/>
  <module name="{string}"/>
  <source-data name="{string}"/>
  <target-data name="{string}"/>
</action:python>

Valid Subtags:

• path 0..1
• module 1
• source-data 0..1
• target-data 0..1

path

Directory path to Python module, i.e. script file. If it doesn’t occur, the current path is used

Example:

<path name=""/>

module

Name of Python module, i.e. Python script file without file ending. The module name has to differ from existing (library) modules, otherwise, the existing module will be loaded instead of the user script.

Example:

<module name="{string}"/>

source-data

Source data to be read is handed to the Python module. Can be omitted, if only a target data is needed.

Example:

<source-data name="{string}"/>

target-data

Target data to be read and written to is handed to the Python module. Can be omitted, if only source data is needed.

Example:

<target-data name="{string}"/>

export:vtk

Exports meshes to VTK legacy format files. Parallel participants will use the VTU exporter instead.

Example:

<export:vtk every-n-time-windows="1" directory="" every-iteration="0"/>

export:vtu

Exports meshes to VTU files in serial or PVTU files with VTU piece files in parallel.

Example:

<export:vtu every-n-time-windows="1" directory="" every-iteration="0"/>

export:vtp

Exports meshes to VTP files in serial or PVTP files with VTP piece files in parallel.

Example:

<export:vtp every-n-time-windows="1" directory="" every-iteration="0"/>

export:csv

Exports vertex coordinates and data to CSV files.

Example:

<export:csv every-n-time-windows="1" directory="" every-iteration="0"/>

watch-point

A watch point can be used to follow the transient changes of data and mesh vertex coordinates at a given point

Example:

<watch-point mesh="{string}" name="{string}" coordinate="{vector}"/>

watch-integral

A watch integral can be used to follow the transient change of integral data and surface area for a given coupling mesh.

Example:

<watch-integral mesh="{string}" name="{string}" scale-with-connectivity="{boolean}"/>

provide-mesh

Provide a mesh (see tag ) to other participants.

Example:

<provide-mesh name="{string}"/>

receive-mesh

Makes a remote mesh (see tag ) available to this participant.

Example:

<receive-mesh safety-factor="0.5" from="{string}" geometric-filter="on-secondary-ranks" name="{string}" direct-access="0"/>

intra-comm:sockets

A solver in parallel needs a communication between its ranks. By default, the participant’s MPI_COM_WORLD is reused.Use this tag to use TCP/IP sockets instead.

Example:

<intra-comm:sockets port="0" exchange-directory="" network="lo"/>

intra-comm:mpi

A solver in parallel needs a communication between its ranks. By default, the participant’s MPI_COM_WORLD is reused.Use this tag to use MPI with separated communication spaces instead instead.

Example:

<intra-comm:mpi exchange-directory=""/>

coupling-scheme:serial-explicit

Explicit coupling scheme according to conventional serial staggered procedure (CSS).

Example:

<coupling-scheme:serial-explicit>
  <max-time value="{float}"/>
  <max-time-windows value="{integer}"/>
  <time-window-size value="-1" method="fixed"/>
  <participants first="{string}" second="{string}"/>
  <exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>
</coupling-scheme:serial-explicit>

Valid Subtags:

• max-time 0..1
• max-time-windows 0..1
• time-window-size 1
• participants 1
• exchange 1..*

max-time

Defined the end of the simulation as total time.

Example:

<max-time value="{float}"/>

max-time-windows

Defined the end of the simulation as a total count of time windows.

Example:

<max-time-windows value="{integer}"/>

time-window-size

Defines the size of the time window.

Example:

<time-window-size value="-1" method="fixed"/>

participants

Defines the participants of the coupling scheme.

Example:

<participants first="{string}" second="{string}"/>

exchange

Defines the flow of data between meshes of participants.

Example:

<exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>

coupling-scheme:parallel-explicit

Explicit coupling scheme according to conventional parallel staggered procedure (CPS).

Example:

<coupling-scheme:parallel-explicit>
  <max-time value="{float}"/>
  <max-time-windows value="{integer}"/>
  <time-window-size value="-1"/>
  <participants first="{string}" second="{string}"/>
  <exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>
</coupling-scheme:parallel-explicit>

Valid Subtags:

• max-time 0..1
• max-time-windows 0..1
• time-window-size 1
• participants 1
• exchange 1..*

max-time

Defined the end of the simulation as total time.

Example:

<max-time value="{float}"/>

max-time-windows

Defined the end of the simulation as a total count of time windows.

Example:

<max-time-windows value="{integer}"/>

time-window-size

Defines the size of the time window.

Example:

<time-window-size value="-1"/>

participants

Defines the participants of the coupling scheme.

Example:

<participants first="{string}" second="{string}"/>

exchange

Defines the flow of data between meshes of participants.

Example:

<exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>

coupling-scheme:serial-implicit

Implicit coupling scheme according to block Gauss-Seidel iterations (S-System). Improved implicit iterations are achieved by using a acceleration (recommended!).

Example:

<coupling-scheme:serial-implicit>
  <max-time value="{float}"/>
  <max-time-windows value="{integer}"/>
  <time-window-size value="-1" method="fixed"/>
  <participants first="{string}" second="{string}"/>
  <exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>
  <acceleration:constant>
    ...
  </acceleration:constant>
  <absolute-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <absolute-or-relative-convergence-measure abs-limit="{float}" rel-limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <residual-relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <min-iterations value="{integer}"/>
  <max-iterations value="{integer}"/>
</coupling-scheme:serial-implicit>

Valid Subtags:

• max-time 0..1
• max-time-windows 0..1
• time-window-size 1
• participants 1
• exchange 1..*
• absolute-convergence-measure 0..*
• absolute-or-relative-convergence-measure 0..*
• relative-convergence-measure 0..*
• residual-relative-convergence-measure 0..*
• min-iterations 0..1
• max-iterations 0..1
• acceleration
  • constant 0..1
  • aitken 0..1
  • IQN-ILS 0..1
  • IQN-IMVJ 0..1

max-time

Defined the end of the simulation as total time.

Example:

<max-time value="{float}"/>

max-time-windows

Defined the end of the simulation as a total count of time windows.

Example:

<max-time-windows value="{integer}"/>

time-window-size

Defines the size of the time window.

Example:

<time-window-size value="-1" method="fixed"/>

participants

Defines the participants of the coupling scheme.

Example:

<participants first="{string}" second="{string}"/>

exchange

Defines the flow of data between meshes of participants.

Example:

<exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>

acceleration:constant

Accelerates coupling data with constant underrelaxation.

Example:

<acceleration:constant>
  <relaxation value="{float}"/>
</acceleration:constant>

Valid Subtags:

• relaxation 1

relaxation

Example:

<relaxation value="{float}"/>

acceleration:aitken

Accelerates coupling data with dynamic Aitken under-relaxation.

Example:

<acceleration:aitken>
  <initial-relaxation value="{float}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:aitken>

Valid Subtags:

• initial-relaxation 1
• data 1..*
• preconditioner 0..1

initial-relaxation

Initial relaxation factor.

Example:

<initial-relaxation value="{float}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

preconditioner

To improve the numerical stability of multiple data vectors a preconditioner can be applied. A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data. A value preconditioner scales every acceleration data by the norm of the data in the previous time window. A residual preconditioner scales every acceleration data by the current residual. A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

acceleration:IQN-ILS

Accelerates coupling data with the interface quasi-Newton inverse least-squares method.

Example:

<acceleration:IQN-ILS>
  <initial-relaxation value="{float}" enforce="0"/>
  <max-used-iterations value="{integer}"/>
  <time-windows-reused value="{integer}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <filter limit="1e-16" type="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:IQN-ILS>

Valid Subtags:

• initial-relaxation 0..1
• max-used-iterations 0..1
• time-windows-reused 0..1
• data 1..*
• filter 0..1
• preconditioner 0..1

initial-relaxation

Initial relaxation factor. If this tag is not provided, an initial relaxation of 0.1 is used.

Example:

<initial-relaxation value="{float}" enforce="0"/>

max-used-iterations

Maximum number of columns used in low-rank approximation of Jacobian. If this tag is not provided, the attribute value of 100 is used.

Example:

<max-used-iterations value="{integer}"/>

time-windows-reused

Number of past time windows from which columns are used to approximate Jacobian. If this tag is not provided, the default attribute value of 10 is used.

Example:

<time-windows-reused value="{integer}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

filter

Type of filtering technique that is used to maintain good conditioning in the least-squares system. Possible filters:

• QR1-filter: updateQR-dec with (relative) test \(R(i,i) < \epsilon *\lVert R\rVert_F\)
• QR1_absolute-filter: updateQR-dec with (absolute) test \(R(i, i) < \epsilon\)
• QR2-filter: en-block QR-dec with test \(\lVert v_\text{orth} \rVert_2 < \epsilon * \lVert v \rVert_2\)

Please note that a QR1 is based on Given’s rotations whereas QR2 uses modified Gram-Schmidt. This can give different results even when no columns are filtered out. When this tag is not provided, the QR2-filter with the limit value 1e-2 is used.

Example:

<filter limit="1e-16" type="{string}"/>

preconditioner

To improve the performance of a parallel or a multi coupling schemes a preconditioner can be applied. - A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data.

• A value preconditioner scales every acceleration data by the norm of the data in the previous time window.
• A residual preconditioner scales every acceleration data by the current residual.
• A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window. If this tag is not provided, the residual-sum preconditioner is employed.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

acceleration:IQN-IMVJ

Accelerates coupling data with the interface quasi-Newton inverse multi-vector Jacobian method.

Example:

<acceleration:IQN-IMVJ always-build-jacobian="0">
  <initial-relaxation value="{float}" enforce="0"/>
  <imvj-restart-mode truncation-threshold="0.0001" chunk-size="8" reused-time-windows-at-restart="8" type="RS-SVD"/>
  <max-used-iterations value="{integer}"/>
  <time-windows-reused value="{integer}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <filter limit="1e-16" type="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:IQN-IMVJ>

Valid Subtags:

• initial-relaxation 0..1
• imvj-restart-mode 0..1
• max-used-iterations 0..1
• time-windows-reused 0..1
• data 1..*
• filter 0..1
• preconditioner 0..1

initial-relaxation

Initial relaxation factor. If this tag is not provided, an initial relaxation of 0.1 is used.

Example:

<initial-relaxation value="{float}" enforce="0"/>

imvj-restart-mode

Type of IMVJ restart mode that is used:

• no-restart: IMVJ runs in normal mode with explicit representation of Jacobian
• RS-ZERO: IMVJ runs in restart mode. After M time windows all Jacobain information is dropped, restart with no information
• RS-LS: IMVJ runs in restart mode. After M time windows a IQN-LS like approximation for the initial guess of the Jacobian is computed.
• RS-SVD: IMVJ runs in restart mode. After M time windows a truncated SVD of the Jacobian is updated.
• RS-SLIDE: IMVJ runs in sliding window restart mode. If this tag is not provided, IMVJ runs in normal mode with explicit representation of Jacobian.

Example:

<imvj-restart-mode truncation-threshold="0.0001" chunk-size="8" reused-time-windows-at-restart="8" type="RS-SVD"/>

max-used-iterations

Maximum number of columns used in low-rank approximation of Jacobian. If this tag is not provided, the default attribute value of 20 is used.

Example:

<max-used-iterations value="{integer}"/>

time-windows-reused

Number of past time windows from which columns are used to approximate Jacobian. If this tag is not provided, the attribute value of 0 is used.

Example:

<time-windows-reused value="{integer}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

filter

Type of filtering technique that is used to maintain good conditioning in the least-squares system. Possible filters:

• QR1-filter: updateQR-dec with (relative) test \(R(i,i) < \epsilon *\lVert R\rVert_F\)
• QR1_absolute-filter: updateQR-dec with (absolute) test \(R(i, i) < \epsilon\)
• QR2-filter: en-block QR-dec with test \(\lVert v_\text{orth} \rVert_2 < \epsilon * \lVert v \rVert_2\)

Please note that a QR1 is based on Given’s rotations whereas QR2 uses modified Gram-Schmidt. This can give different results even when no columns are filtered out. When this tag is not provided, the QR2-filter with the limit value 1e-2 is used.

Example:

<filter limit="1e-16" type="{string}"/>

preconditioner

To improve the performance of a parallel or a multi coupling schemes a preconditioner can be applied.- A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data.

• A value preconditioner scales every acceleration data by the norm of the data in the previous time window.
• A residual preconditioner scales every acceleration data by the current residual.
• A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window. If this tag is not provided, the residual-sum preconditioner is employed.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

absolute-convergence-measure

Absolute convergence criterion based on the two-norm difference of data values between iterations. $$\left\lVert H(x^k) - x^k \right\rVert_2 < \text{limit}$$

Example:

<absolute-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

absolute-or-relative-convergence-measure

Absolute or relative convergence, which is the disjunction of an absolute criterion based on the two-norm difference of data values between iterations and a relative criterion based on the relative two-norm difference of data values between iterations,i.e. convergence is reached as soon as one of the both criteria is fulfilled.$$\left\lVert H(x^k) - x^k \right\rVert_2 < \text{abs-limit}\quad\text{or}\quad\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^k) \right\rVert_2} < \text{rel-limit} $$

Example:

<absolute-or-relative-convergence-measure abs-limit="{float}" rel-limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

relative-convergence-measure

Relative convergence criterion based on the relative two-norm difference of data values between iterations. $$\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^k) \right\rVert_2} < \text{limit} $$

Example:

<relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

residual-relative-convergence-measure

Relative convergence criterion comparing the currently measured residual to the residual of the first iteration in the time window. $$\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^0) - x^0 \right\rVert_2} < \text{limit}$$

Example:

<residual-relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

min-iterations

Allows to specify a minimum amount of iterations that must be performed per time window.

Example:

<min-iterations value="{integer}"/>

max-iterations

Allows to specify a maximum amount of iterations per time window.

Example:

<max-iterations value="{integer}"/>

coupling-scheme:parallel-implicit

Parallel Implicit coupling scheme according to block Jacobi iterations (V-System). Improved implicit iterations are achieved by using a acceleration (recommended!).

Example:

<coupling-scheme:parallel-implicit>
  <max-time value="{float}"/>
  <max-time-windows value="{integer}"/>
  <time-window-size value="-1"/>
  <participants first="{string}" second="{string}"/>
  <exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>
  <acceleration:constant>
    ...
  </acceleration:constant>
  <absolute-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <absolute-or-relative-convergence-measure abs-limit="{float}" rel-limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <residual-relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <min-iterations value="{integer}"/>
  <max-iterations value="{integer}"/>
</coupling-scheme:parallel-implicit>

Valid Subtags:

• max-time 0..1
• max-time-windows 0..1
• time-window-size 1
• participants 1
• exchange 1..*
• absolute-convergence-measure 0..*
• absolute-or-relative-convergence-measure 0..*
• relative-convergence-measure 0..*
• residual-relative-convergence-measure 0..*
• min-iterations 0..1
• max-iterations 0..1
• acceleration
  • constant 0..1
  • aitken 0..1
  • IQN-ILS 0..1
  • IQN-IMVJ 0..1

max-time

Defined the end of the simulation as total time.

Example:

<max-time value="{float}"/>

max-time-windows

Defined the end of the simulation as a total count of time windows.

Example:

<max-time-windows value="{integer}"/>

time-window-size

Defines the size of the time window.

Example:

<time-window-size value="-1"/>

participants

Defines the participants of the coupling scheme.

Example:

<participants first="{string}" second="{string}"/>

exchange

Defines the flow of data between meshes of participants.

Example:

<exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>

acceleration:constant

Accelerates coupling data with constant underrelaxation.

Example:

<acceleration:constant>
  <relaxation value="{float}"/>
</acceleration:constant>

Valid Subtags:

• relaxation 1

relaxation

Example:

<relaxation value="{float}"/>

acceleration:aitken

Accelerates coupling data with dynamic Aitken under-relaxation.

Example:

<acceleration:aitken>
  <initial-relaxation value="{float}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:aitken>

Valid Subtags:

• initial-relaxation 1
• data 1..*
• preconditioner 0..1

initial-relaxation

Initial relaxation factor.

Example:

<initial-relaxation value="{float}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

preconditioner

To improve the numerical stability of multiple data vectors a preconditioner can be applied. A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data. A value preconditioner scales every acceleration data by the norm of the data in the previous time window. A residual preconditioner scales every acceleration data by the current residual. A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

acceleration:IQN-ILS

Accelerates coupling data with the interface quasi-Newton inverse least-squares method.

Example:

<acceleration:IQN-ILS>
  <initial-relaxation value="{float}" enforce="0"/>
  <max-used-iterations value="{integer}"/>
  <time-windows-reused value="{integer}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <filter limit="1e-16" type="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:IQN-ILS>

Valid Subtags:

• initial-relaxation 0..1
• max-used-iterations 0..1
• time-windows-reused 0..1
• data 1..*
• filter 0..1
• preconditioner 0..1

initial-relaxation

Initial relaxation factor. If this tag is not provided, an initial relaxation of 0.1 is used.

Example:

<initial-relaxation value="{float}" enforce="0"/>

max-used-iterations

Maximum number of columns used in low-rank approximation of Jacobian. If this tag is not provided, the attribute value of 100 is used.

Example:

<max-used-iterations value="{integer}"/>

time-windows-reused

Number of past time windows from which columns are used to approximate Jacobian. If this tag is not provided, the default attribute value of 10 is used.

Example:

<time-windows-reused value="{integer}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

filter

Type of filtering technique that is used to maintain good conditioning in the least-squares system. Possible filters:

• QR1-filter: updateQR-dec with (relative) test \(R(i,i) < \epsilon *\lVert R\rVert_F\)
• QR1_absolute-filter: updateQR-dec with (absolute) test \(R(i, i) < \epsilon\)
• QR2-filter: en-block QR-dec with test \(\lVert v_\text{orth} \rVert_2 < \epsilon * \lVert v \rVert_2\)

Please note that a QR1 is based on Given’s rotations whereas QR2 uses modified Gram-Schmidt. This can give different results even when no columns are filtered out. When this tag is not provided, the QR2-filter with the limit value 1e-2 is used.

Example:

<filter limit="1e-16" type="{string}"/>

preconditioner

To improve the performance of a parallel or a multi coupling schemes a preconditioner can be applied. - A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data.

• A value preconditioner scales every acceleration data by the norm of the data in the previous time window.
• A residual preconditioner scales every acceleration data by the current residual.
• A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window. If this tag is not provided, the residual-sum preconditioner is employed.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

acceleration:IQN-IMVJ

Accelerates coupling data with the interface quasi-Newton inverse multi-vector Jacobian method.

Example:

<acceleration:IQN-IMVJ always-build-jacobian="0">
  <initial-relaxation value="{float}" enforce="0"/>
  <imvj-restart-mode truncation-threshold="0.0001" chunk-size="8" reused-time-windows-at-restart="8" type="RS-SVD"/>
  <max-used-iterations value="{integer}"/>
  <time-windows-reused value="{integer}"/>
  <data scaling="1" mesh="{string}" name="{string}"/>
  <filter limit="1e-16" type="{string}"/>
  <preconditioner freeze-after="-1" type="{string}"/>
</acceleration:IQN-IMVJ>

Valid Subtags:

• initial-relaxation 0..1
• imvj-restart-mode 0..1
• max-used-iterations 0..1
• time-windows-reused 0..1
• data 1..*
• filter 0..1
• preconditioner 0..1

initial-relaxation

Initial relaxation factor. If this tag is not provided, an initial relaxation of 0.1 is used.

Example:

<initial-relaxation value="{float}" enforce="0"/>

imvj-restart-mode

Type of IMVJ restart mode that is used:

• no-restart: IMVJ runs in normal mode with explicit representation of Jacobian
• RS-ZERO: IMVJ runs in restart mode. After M time windows all Jacobain information is dropped, restart with no information
• RS-LS: IMVJ runs in restart mode. After M time windows a IQN-LS like approximation for the initial guess of the Jacobian is computed.
• RS-SVD: IMVJ runs in restart mode. After M time windows a truncated SVD of the Jacobian is updated.
• RS-SLIDE: IMVJ runs in sliding window restart mode. If this tag is not provided, IMVJ runs in normal mode with explicit representation of Jacobian.

Example:

<imvj-restart-mode truncation-threshold="0.0001" chunk-size="8" reused-time-windows-at-restart="8" type="RS-SVD"/>

max-used-iterations

Maximum number of columns used in low-rank approximation of Jacobian. If this tag is not provided, the default attribute value of 20 is used.

Example:

<max-used-iterations value="{integer}"/>

time-windows-reused

Number of past time windows from which columns are used to approximate Jacobian. If this tag is not provided, the attribute value of 0 is used.

Example:

<time-windows-reused value="{integer}"/>

data

The data used to compute the acceleration.

Example:

<data scaling="1" mesh="{string}" name="{string}"/>

filter

Type of filtering technique that is used to maintain good conditioning in the least-squares system. Possible filters:

• QR1-filter: updateQR-dec with (relative) test \(R(i,i) < \epsilon *\lVert R\rVert_F\)
• QR1_absolute-filter: updateQR-dec with (absolute) test \(R(i, i) < \epsilon\)
• QR2-filter: en-block QR-dec with test \(\lVert v_\text{orth} \rVert_2 < \epsilon * \lVert v \rVert_2\)

Please note that a QR1 is based on Given’s rotations whereas QR2 uses modified Gram-Schmidt. This can give different results even when no columns are filtered out. When this tag is not provided, the QR2-filter with the limit value 1e-2 is used.

Example:

<filter limit="1e-16" type="{string}"/>

preconditioner

To improve the performance of a parallel or a multi coupling schemes a preconditioner can be applied.- A constant preconditioner scales every acceleration data by a constant value, which you can define as an attribute of data.

• A value preconditioner scales every acceleration data by the norm of the data in the previous time window.
• A residual preconditioner scales every acceleration data by the current residual.
• A residual-sum preconditioner scales every acceleration data by the sum of the residuals from the current time window. If this tag is not provided, the residual-sum preconditioner is employed.

Example:

<preconditioner freeze-after="-1" type="{string}"/>

absolute-convergence-measure

Absolute convergence criterion based on the two-norm difference of data values between iterations. $$\left\lVert H(x^k) - x^k \right\rVert_2 < \text{limit}$$

Example:

<absolute-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

absolute-or-relative-convergence-measure

Absolute or relative convergence, which is the disjunction of an absolute criterion based on the two-norm difference of data values between iterations and a relative criterion based on the relative two-norm difference of data values between iterations,i.e. convergence is reached as soon as one of the both criteria is fulfilled.$$\left\lVert H(x^k) - x^k \right\rVert_2 < \text{abs-limit}\quad\text{or}\quad\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^k) \right\rVert_2} < \text{rel-limit} $$

Example:

<absolute-or-relative-convergence-measure abs-limit="{float}" rel-limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

relative-convergence-measure

Relative convergence criterion based on the relative two-norm difference of data values between iterations. $$\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^k) \right\rVert_2} < \text{limit} $$

Example:

<relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

residual-relative-convergence-measure

Relative convergence criterion comparing the currently measured residual to the residual of the first iteration in the time window. $$\frac{\left\lVert H(x^k) - x^k \right\rVert_2}{\left\lVert H(x^0) - x^0 \right\rVert_2} < \text{limit}$$

Example:

<residual-relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>

min-iterations

Allows to specify a minimum amount of iterations that must be performed per time window.

Example:

<min-iterations value="{integer}"/>

max-iterations

Allows to specify a maximum amount of iterations per time window.

Example:

<max-iterations value="{integer}"/>

coupling-scheme:multi

Multi coupling scheme according to block Jacobi iterations. Improved implicit iterations are achieved by using a acceleration (recommended!).

Example:

<coupling-scheme:multi>
  <max-time value="{float}"/>
  <max-time-windows value="{integer}"/>
  <time-window-size value="-1"/>
  <participant name="{string}" control="0"/>
  <exchange data="{string}" from="{string}" mesh="{string}" to="{string}" initialize="0" substeps="0"/>
  <acceleration:constant>
    ...
  </acceleration:constant>
  <absolute-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <absolute-or-relative-convergence-measure abs-limit="{float}" rel-limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <residual-relative-convergence-measure limit="{float}" data="{string}" mesh="{string}" strict="0" suffices="0"/>
  <min-iterations value="{integer}"/>
  <max-iterations value="{integer}"/>
</coupling-scheme:multi>