Patch lattice layers

Table of Contents

• Layer initialization
  • Example: Initializing one lattice layer
  • Example: Initializing two lattice layers
• Layer parameters
  • Example: Modifying layer parameters
  • Example: Modifying layer operation parameters
• Quantity operations
  • Example: Including operation versions

The layer tag defines a single layer. Nested tags include layer.parameter for parameters and layer.operation for operations.

<layers>
    <layer id="[ID]">
        <layer.parameter id="[ID]" value="[VALUE]" scale="[SCALE]" />
        <layer.parameter id="[ID]" value="[VALUE]" scale="[SCALE]" operation="[OPERATION]" />
        <layer.operation id="[ID]" />
        ...
    </layer>
    ...
</layers>

Layer initialization

The layer tag initialization are used to initialize the layer.

• Each layer must have a unique id

ATTRIBUTE	DESCRIPTION	TYPE	REQUIRED
id	unique name for the layer	string	Y

Example: Initializing one lattice layer

Specifies a lattice layer, A.

<layers>
    <layer id="A" />
</layers>

Example: Initializing two lattice layers

Specifies two lattice layers, A and B.

<layers>
    <layer id="A" />
    <layer id="B" />
</layers>

Layer parameters

The layer.parameter tag defines layer parameters. Unless modified, default values are used for all parameters. Defaults are listed in parameter.patch.xml.

• Either or both value and scale attributes can be applied, with value applied first
• Only numeric parameters can be modified using scale
• Changes for parameters specific to a operation can be applied to using the operation attribute

ATTRIBUTE	DESCRIPTION
id	parameter name
value	new parameter value
scale	scaling factor applied to parameter value
operation	operation the parameter belongs to

Example: Modifying layer parameters

The initial concentration parameter is set to the new value 2000.

<layer.parameter id="INITIAL_CONCENTRATION" value="2000" />

The default value of the initial concentration parameter is scaled by 2.

<layer.parameter id="INITIAL_CONCENTRATION" scale="2" />

The initial concentration parameter is set to the new value 10 * 2 = 20.

<layer.parameter id="INITIAL_CONCENTRATION" value="10" scale="2" />

Example: Modifying layer operation parameters

The diffusivity parameter for the diffuser operation is set to the new value 3.

<layer.parameter id="DIFFUSIVITY" operation="diffuser" value="3" />

Quantity operations

The layer.operation tag lists operations on quantities in the layer. Valid options include:

GENERATOR

Operation for generating the quantity in the lattice

DIFFUSER

Operation for diffusing the quantity in the lattice

ATTRIBUTE	DESCRIPTION
id	operation option id

To modify operation parameters, use the layer.parameter tag with the corresponding operation attribute.

Example: Including operation versions

Specifies a layer with generator and diffuser operations.

<layer.operation id="GENERATOR" />
<layer.operation id="DIFFUSER" />