src/ElectromagnetismStreamTraceur/plugin/filters.xml

   1 <ServerManagerConfiguration>
   2
   3   <ProxyGroup name="filters">
   4
   5     <SourceProxy class="vtkElectromagnetismStreamTraceur"
   6                  label=" Ligne De Champ"
   7                  name="LigneDeChamp">
   8       <Documentation long_help="Int."
   9                      short_help="Int.">The
  10                      Stream Tracer filter generates streamlines in a vector
  11                      field from a colleces.
  12       </Documentation>
  13
  14       <InputProperty clean_command="RemoveAllInputs"
  15                      command="AddInputConnection"
  16                      name="Input">
  17         <ProxyGroupDomain name="groups">
  18           <Group name="sources" />
  19           <Group name="filters" />
  20         </ProxyGroupDomain>
  21         <DataTypeDomain composite_data_supported="1"
  22                         name="input_type">
  23           <DataType value="vtkDataSet" />
  24         </DataTypeDomain>
  25         <InputArrayDomain name="input_array"
  26                           number_of_components="3" />
  27         <Documentation>This property specifies the input to the Stream Tracer
  28         filter.</Documentation>
  29       </InputProperty>
  30       <StringVectorProperty animateable="0"
  31                             command="SetInputArrayToProcess"
  32                             element_types="0 0 0 0 2"
  33                             label="Vectors"
  34                             name="SelectInputVectors"
  35                             number_of_elements="5">
  36         <ArrayListDomain attribute_type="Vectors"
  37                          name="array_list">
  38           <RequiredProperties>
  39             <Property function="Input"
  40                       name="Input" />
  41           </RequiredProperties>
  42         </ArrayListDomain>
  43         <Documentation>This property contains the name of the vector array from
  44         which to generate streamlines.</Documentation>
  45       </StringVectorProperty>
  46
  47       <InputProperty command="SetSourceConnection"
  48                      label="Seed Type"
  49                      name="Source"
  50                      panel_visibility="default">
  51         <ProxyGroupDomain name="groups">
  52           <Group name="sources" />
  53         </ProxyGroupDomain>
  54         <ProxyListDomain name="proxy_list">
  55           <Group name="seed_sources"/>
  56         </ProxyListDomain>
  57         <Documentation>The value of this property determines how the seeds for
  58         the streamlines will be generated.</Documentation>
  59       </InputProperty>
  60
  61
  62
  63
  64       <IntVectorProperty command="SetIntegrationDirection"
  65                          default_values="2"
  66                          name="IntegrationDirection"
  67                          number_of_elements="1">
  68         <EnumerationDomain name="enum">
  69           <Entry text="FORWARD"
  70                  value="0" />
  71           <Entry text="BACKWARD"
  72                  value="1" />
  73           <Entry text="BOTH"
  74                  value="2" />
  75         </EnumerationDomain>
  76         <Documentation>This property determines in which direction(s) a
  77         streamline is generated.</Documentation>
  78       </IntVectorProperty>
  79       <IntVectorProperty command="SetIntegratorType"
  80                          default_values="2"
  81                          name="IntegratorType"
  82                          number_of_elements="1">
  83         <EnumerationDomain name="enum">
  84           <Entry text="Runge-Kutta 2"
  85                  value="0" />
  86           <Entry text="Runge-Kutta 4"
  87                  value="1" />
  88           <Entry text="Runge-Kutta 4-5"
  89                  value="2" />
  90         </EnumerationDomain>
  91         <Documentation>This property determines which integrator (with
  92         increasing accuracy) to use for creating streamlines.</Documentation>
  93       </IntVectorProperty>
  94       <IntVectorProperty command="SetIntegrationStepUnit"
  95                          default_values="2"
  96                          label="Integration Step Unit"
  97                          name="IntegrationStepUnit"
  98                          number_of_elements="1"
  99                          panel_visibility="advanced">
 100         <EnumerationDomain name="enum">
 101           <Entry text="Length"
 102                  value="1" />
 103           <Entry text="Cell Length"
 104                  value="2" />
 105         </EnumerationDomain>
 106         <Documentation>This property specifies the unit for
 107         Minimum/Initial/Maximum integration step size. The Length unit refers
 108         to the arc length that a particle travels/advects within a single step.
 109         The Cell Length unit represents the step size as a number of
 110         cells.</Documentation>
 111       </IntVectorProperty>
 112       <DoubleVectorProperty command="SetInitialIntegrationStep"
 113                             default_values="0.2"
 114                             label="Initial Step Length"
 115                             name="InitialIntegrationStep"
 116                             number_of_elements="1"
 117                             panel_visibility="advanced" >
 118         <DoubleRangeDomain name="range" />
 119         <Documentation>This property specifies the initial integration step
 120         size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4),
 121         it is fixed (always equal to this initial value) throughout the
 122         integration. For an adaptive integrator (Runge-Kutta 4-5), the actual
 123         step size varies such that the numerical error is less than a specified
 124         threshold.</Documentation>
 125       </DoubleVectorProperty>
 126       <DoubleVectorProperty command="SetMinimumIntegrationStep"
 127                             default_values="0.01"
 128                             label="Minimum Step Length"
 129                             name="MinimumIntegrationStep"
 130                             number_of_elements="1"
 131                             panel_visibility="advanced" >
 132         <DoubleRangeDomain name="range" />
 133         <Documentation>When using the Runge-Kutta 4-5 integrator, this property
 134         specifies the minimum integration step size.</Documentation>
 135       </DoubleVectorProperty>
 136       <DoubleVectorProperty command="SetMaximumIntegrationStep"
 137                             default_values="0.5"
 138                             label="Maximum Step Length"
 139                             name="MaximumIntegrationStep"
 140                             number_of_elements="1"
 141                             panel_visibility="advanced">
 142         <DoubleRangeDomain name="range" />
 143         <Documentation>When using the Runge-Kutta 4-5 integrator, this property
 144         specifies the maximum integration step size.</Documentation>
 145       </DoubleVectorProperty>
 146       <IntVectorProperty command="SetMaximumNumberOfSteps"
 147                          default_values="2000"
 148                          label="Maximum Steps"
 149                          name="MaximumNumberOfSteps"
 150                          number_of_elements="1"
 151                          panel_visibility="advanced">
 152         <IntRangeDomain name="range" />
 153         <Documentation>This property specifies the maximum number of steps,
 154         beyond which streamline integration is terminated.</Documentation>
 155       </IntVectorProperty>
 156       <DoubleVectorProperty command="SetTerminalSpeed"
 157                             default_values="0.000000000001"
 158                             label="Terminal Speed"
 159                             name="TerminalSpeed"
 160                             number_of_elements="1"
 161                             panel_visibility="advanced" >
 162         <DoubleRangeDomain name="range" />
 163         <Documentation>This property specifies the terminal speed, below which
 164         particle advection/integration is terminated.</Documentation>
 165       </DoubleVectorProperty>
 166       <DoubleVectorProperty command="SetMaximumError"
 167                             default_values="0.000001"
 168                             name="MaximumError"
 169                             number_of_elements="1"
 170                             panel_visibility="advanced" >
 171         <DoubleRangeDomain name="range" />
 172         <Documentation>This property specifies the maximum error (for
 173         Runge-Kutta 4-5) tolerated throughout streamline integration. The
 174         Runge-Kutta 4-5 integrator tries to adjust the step size such that the
 175         estimated error is less than this threshold.</Documentation>
 176       </DoubleVectorProperty>
 177
 178       <Hints>
 179         <RepresentationType view="RenderView" type="Wireframe"/>
 180         <ShowInMenu category="Electromagnetism" />
 181         <Visibility replace_input="2" />
 182       </Hints>
 183
 184       <PropertyGroup label="Seeds">
 185         <Property name="Source" />
 186       </PropertyGroup>
 187
 188       <PropertyGroup label="Integration Parameters">
 189         <Property name="IntegrationDirection" />
 190         <Property name="IntegratorType" />
 191         <Property name="IntegrationStepUnit" />
 192         <Property name="InitialIntegrationStep" />
 193         <Property name="MinimumIntegrationStep" />
 194         <Property name="MaximumIntegrationStep" />
 195         <Property name="MaximumError" />
 196       </PropertyGroup>
 197
 198       <PropertyGroup label="Streamline Parameters" >
 199         <Property name="MaximumNumberOfSteps" />
 200         <Property name="TerminalSpeed" />
 201       </PropertyGroup>
 202     </SourceProxy>
 203   </ProxyGroup>
 204 </ServerManagerConfiguration>