/home/jaubrey/webwork//pg_TRUNK/lib/VectorField.pm

From WeBWorK

Jump to: navigation


NAME

        VectorField

SYNPOSIS

        use Carp;
        use GD;
        use WWPlot;
        use Fun;
        $fn = new Fun( rule_reference);
        $fn = new Fun( rule_reference , graph_reference);
        $fn = new Fun ( x_rule_ref, y_rule_ref );
        $fn = new Fun ( x_rule_ref, y_rule_ref, graph_ref );

DESCRIPTION

This module defines a phase plane vector field. It can also be used to define direction fields for differenential equations.

The following functions are provided:

new (direction field version)

$fn = new VectorField( dy_rule_ref);

rule_reference is a reference to a subroutine which accepts a pair of numerical values and returns a numerical value. The Fun object will draw the direction field associated with this subroutine.

The new method returns a reference to the vector field object.

$fn = new Fun( rule_reference , graph_reference);

The vector field is also placed into the printing queue of the graph object pointed to by graph_reference and the domain of the vector field object is set to the domain of the graph.

new (phase plane version)

$fn = new VectorField ( dx_rule_ref, dy_rule_ref );

A vector field object is created where the subroutines refered to by dx_rule_ref and dy_rule_ref define the x and y components of the vector field at (x,y). Both subroutines must be functions of two variables.

$fn = new VectorField ( x_rule_ref, y_rule_ref, graph_ref );

This variant inserts the vector field object into the graph object referred to by graph_ref. The domain of the vector field object is set to the domain of the graph.

Properites

        All of the properties are set using the construction $new_value = $fn->property($new_value)
        and read using $current_value = $fn->property()
xmin, xmax, ymin, ymax

The domain of the vector field defined by these values.

x_steps y_steps

This gives the number of intervals in the x direction (respectively the y direction) for plotting the vector field arrows.

arrow_color, dot_color

The colors of the arrow bodies and the dot "base" of the arrow are specified by a word such as 'orange' or 'yellow'. $vf-arrow_color('blue'); $vf->dot_color('red');> sets the drawing color to blue for the arrow body, with a red dot at the base of the arrow. The RGB values for the color are defined in the graph object in which the vector field is drawn. If the color, e.g. 'mauve', is not defined by the graph object then the function is drawn using the color 'default_color' which is always defined (and usually black).

dx_rule

A reference to the subroutine used to calculate the dx value of the phase plane field. This is set to the constant function 1 when using the function object in direction field mode.

dy_rule

A reference to the subroutine used to calculate the dy value of the phase plane field.

arrow_weight, dot_weight

The width in pixels of the pen used to draw the arrow (respectively the dot).

Actions which affect more than one property.

domain

$array_ref = $fn->domain(-1,-2,1,2) sets xmin to -1, ymin to -2, xmax to 1, and ymax to 2.

draw

$fn->draw($graph_ref) draws the vector field in the graph object pointed to by $graph_ref.

The graph object must respond to the methods below. The draw call is mainly for internal use by the graph object. Most users will not call it directly.

$graph_ref->{colors}

a hash containing the defined colors

$graph_ref ->im

a GD image object

$graph_ref->lineTo(x,y, color_number)

draw line to the point (x,y) from the current position using the specified color. To obtain the color number use a construction such as $color_number = $graph_ref-{colors}{'blue'};>

$graph_ref->lineTo(x,y,gdBrushed)

draw line to the point (x,y) using the pattern set by SetBrushed (see GD documentation)

$graph_ref->moveTo(x,y)

set the current position to (x,y)