comparison icqsol_solve_laplace.xml @ 0:e04795a38512 draft

Uploaded
author greg
date Mon, 11 Jan 2016 08:55:00 -0500
parents
children 4fc22a63a17e
comparison
equal deleted inserted replaced
-1:000000000000 0:e04795a38512
1 <?xml version='1.0' encoding='UTF-8'?>
2 <tool id="icqsol_solve_laplace" name="Solve Laplace equation" version="@WRAPPER_VERSION@.0">
3 <description>- computes the jump of normal electric field</description>
4 <macros>
5 <import>icqsol_macros.xml</import>
6 </macros>
7 <expand macro="requirements" />
8 <command>
9 <![CDATA[
10 python $__tool_directory__/icqsol_solve_laplace.py
11 --input "$input"
12 --input_file_format_and_type $input.ext
13 --input_dataset_type $input.metadata.dataset_type
14 --input_potential_name "$input_potential_name"
15 --output_jump_electric_field_name "$output_jump_electric_field_name"
16 --output "$output"
17 --output_vtk_type $output_vtk_type
18 ]]>
19 </command>
20 <inputs>
21 <param name="input" type="data" format="vtkascii,vtkbinary" label="Shape" help="Format can be vtkascii or vtkbinary." />
22 <param name="input_potential_name" type="select" label="Field name" refresh_on_change="True">
23 <options>
24 <filter type="data_meta" ref="input" key="field_names"/>
25 <validator type="no_options" message="The selected shape has no surface fields." />
26 </options>
27 </param>
28 <param name="output_jump_electric_field_name" type="text" value="jumpEn" label="Output flux field name" help="Name of the jump of normal electric field name in the output file." />
29 <expand macro="output_vtk_type_params" />
30 </inputs>
31 <outputs>
32 <data name="output" format_source="input">
33 <actions>
34 <action type="format">
35 <option type="from_param" name="output_vtk_type" />
36 </action>
37 </actions>
38 </data>
39 </outputs>
40 <tests>
41 <test>
42 <param name="input" value="sphere.vtkbinary" ftype="vtkbinary" />
43 <param name="input_file_format_and_type" value="vtkbinary" />
44 <param name="input_dataset_type" value="POLYDATA" />
45 <param name="input_potential_name" value="v" />
46 <param name="output_jump_electric_field_name" value="E_normal_jump" />
47 <output name="output" file="sphere_electric_field.vtkascii" ftype="vtkascii" />
48 <param name="output_vtk_type" value="vtkascii" />
49 </test>
50 </tests>
51 <help>
52
53 **What it does**
54
55 Computes the jump in flux-like (Neumann) boundary conditions given prescribed Dirichlet boundary
56 conditions by using the boundary element method. Depending on the problem, the jump can be the
57 surface flux or the normal electric field in electrostatic problems. The Dirichlet field is often
58 called the potential (e.g. electrostatic potential). When the domain extends from the object to
59 infinity and the interior of the object is perfectly conducting, the jump corresponds to the normal
60 electric field just outside the object.
61
62 * **Shape** - Shape whose surface contains a potential field.
63 * **Output flux field name** - Name of the jump of normal electric field name in the output file.
64
65 </help>
66 <expand macro="citations" />
67 </tool>