annotate icqsol_solve_laplace.xml @ 1:696bfb47d45e draft

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