1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="champ1">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>champ1</refname>
<refpurpose>2D vector field plot with colored
arrows</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>champ1(x,y,fx,fy,[arfact,rect,strf])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>x,y</term>
<listitem>
<para>two vectors which define the grid.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>fx</term>
<listitem>
<para>a matrix which describes the x component of the vector field.
<literal>fx(i,j)</literal> is the x component of the vector field at point
<literal>(x(i),y(j))</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>fy</term>
<listitem>
<para>a matrix which describes the y component of the vector field.
<literal>fy(i,j)</literal> is the y component of the vector field at point
<literal>(x(i),y(j))</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>arfact</term>
<listitem>
<para>an optional argument of type real which gives a scale factor
for the display of the arrow heads on the plot (default value is
1.0).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>rect</term>
<listitem>
<para>a vector <literal>rect=[xmin,ymin,xmax,ymax]</literal> which gives
the boundaries of the graphics frame to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>frameflag</term>
<listitem>
<para>controls the computation of the actual coordinate ranges from
the minimal requested values. The associated value should be an
integer ranging from 0 to 8.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>axesflag</term>
<listitem>
<para>specifies how the axes are drawn. The associated value should
be an integer ranging from 0 to 5.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>strf</term>
<listitem>
<para>a string of length 3 "xyz" which has the same meaning as the
<literal>strf</literal> parameter of <literal>plot2d</literal>. The first
character x has no effect with <literal>champ1</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para><literal>champ1</literal> draws a 2D vector field with colored arrows. The
color of the arrows depends on the intensity of the field.</para>
<para>If you want arrows proportional to the intensity of the field, use
<literal>champ</literal>.</para>
<para>Enter the command <literal>champ1()</literal> to see a demo.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
champ1(-5:5,-5:5,rand(11,11),rand(11,11),rect=[-10,-10,10,10],arfact=2)
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="champ">champ</link>
</member>
<member>
<link linkend="fchamp">fchamp</link>
</member>
<member>
<link linkend="plot2d">plot2d</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<para>J.Ph.C.</para>
</refsection>
</refentry>
|
