kswrite_root_condition_step

a write condition for the root writer to reduce output file size while keeping tracking precision only every nth_step (int!) the root writer records a step

XML element: <kswrite_root_condition_step>
C++ type: KSWriteROOTConditionStepData
Attributes

Attribute

Type

Description

group

string

the name of the group the output variable is in (optional)

Refers to the name of one of: <ks_component_group>.

name

string

the name of this write condition.

nth_step

int

the fraction of steps to be recorded

parent

string

the name of the output variable which is used for the write decision (must be of type int)

Refers to the name of any KSComponent object.

Example 1:

<kswrite_root_condition_step name="condition_nth_step" group="component_step_world" parent="step_id" nth_step="{1000}"/>

Example 2:

<ks_component_group name="component_step_world">
    <component_member name="step_id" field="step_id" parent="step"/>
</ks_component_group>

<kswrite_root_condition_step name="condition_nth_step" group="component_step_world" parent="step_id" nth_step="{1000}"/>
<ksgeo_space name="space_world" spaces="world">
    <command parent="write_root" field="add_step_output" child="component_step_world"/>
    <command parent="write_root" field="add_step_write_condition" child="condition_nth_step"/>
</ksgeo_space>

Used as: