phystricks
Public Member Functions | Public Attributes | Private Member Functions | List of all members
phystricks.src.BasicGeometricObjects.VectorFieldGraph Class Reference
Inheritance diagram for phystricks.src.BasicGeometricObjects.VectorFieldGraph:
Inheritance graph
[legend]
Collaboration diagram for phystricks.src.BasicGeometricObjects.VectorFieldGraph:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, F, draw_points)
 
def draw_vectors (self)
 
def pos_x (self)
 
def pos_y (self)
 
def latex_code (self, language=None, pspict=None)
 
- Public Member Functions inherited from phystricks.src.ObjectGraph.ObjectGraph
def __init__ (self, obj)
 
def draw_edges (self)
 
def wave (self, dx, dy)
 
def get_arrow (self, llam)
 
def get_mark (self, dist, angle=None, text=None, mark_point=None, added_angle=None, position=None, pspict=None)
 
def put_mark (self, dist=None, angle=None, text="", mark_point=None, added_angle=None, position=None, pspict=None, pspicts=None)
 put a mark on an object More...
 
def add_option (self, opt)
 
def get_option (opt)
 
def remove_option (opt)
 
def merge_options (self, graph)
 
def conclude_params (self)
 
def params (self, language, refute=[])
 
def bracketAttributesText (self, language, refute=[])
 
def action_on_pspict (self, pspict)
 
def conclude (self, pspict)
 
def bounding_box (self, pspict=None)
 
def math_bounding_box (self, pspict)
 
def latex_code (self, pspict, language=None)
 
- Public Member Functions inherited from phystricks.src.BasicGeometricObjects.GeometricVectorField
def __init__ (self, fx, fy)
 
def divergence (self)
 
def graph (self, xvalues=None, yvalues=None, draw_points=None)
 
def __call__ (self, a, b=None)
 

Public Attributes

 vector_field
 
 F
 
 draw_points
 
- Public Attributes inherited from phystricks.src.ObjectGraph.ObjectGraph
 obj
 
 parameters
 
 wavy
 
 waviness
 
 options
 
 draw_bounding_box
 
 already_computed_BB
 
 already_computed_math_BB
 
 record_add_to_bb
 
 separator_name
 
 in_math_bounding_box
 
 in_bounding_box
 
 added_objects
 
 take_BB
 
 take_math_BB
 
 mark
 
 marque
 
- Public Attributes inherited from phystricks.src.BasicGeometricObjects.GeometricVectorField
 fx
 
 fy
 
 vector_field
 

Private Member Functions

def _math_bounding_box (self, pspict)
 
def _bounding_box (self, pspict=None)
 

Detailed Description

the graph object of a vector field

INPUT:
- ``F`` - a vector field
- ``draw_point`` - the list of points on which it has to be drawn

Typically, in order to construct such an object we use the function
VectorField
and then the method 
GeometricVectorField.graph

See the function VectorField and GeometricVectorField.graph for documentation.

Constructor & Destructor Documentation

def phystricks.src.BasicGeometricObjects.VectorFieldGraph.__init__ (   self,
  F,
  draw_points 
)

Member Function Documentation

def phystricks.src.BasicGeometricObjects.VectorFieldGraph._bounding_box (   self,
  pspict = None 
)
private
def phystricks.src.BasicGeometricObjects.VectorFieldGraph._math_bounding_box (   self,
  pspict 
)
private
def phystricks.src.BasicGeometricObjects.VectorFieldGraph.draw_vectors (   self)
the list of vectors to be drawn
def phystricks.src.BasicGeometricObjects.VectorFieldGraph.latex_code (   self,
  language = None,
  pspict = None 
)
def phystricks.src.BasicGeometricObjects.VectorFieldGraph.pos_x (   self)
return the list of x positions on which there is a drawn vector

The list is sorted

NOTE:

If `self` was created using the optional argument `draw_points`,
then the set of points on which there is a vector
is not equal to the Cartesian product `self.pos_x` times `self.pos_y`

EXAMPLES:

The two lists created in the following example are the same::

    sage: from phystricks import *
    sage: x,y=var('x,y')
    sage: F=VectorField(x,y).graph(xvalues=(x,1,2,3),yvalues=(y,-2,2,3))
    sage: [ P.coordinates() for P in F.draw_points ]
    ['(1.0,-2.0)', '(1.0,0)', '(1.0,2.0)', '(1.5,-2.0)', '(1.5,0)', '(1.5,2.0)', '(2.0,-2.0)', '(2.0,0)', '(2.0,2.0)']

and ::

    sage: x,y=var('x,y')
    sage: [ (x,y) for x in F.pos_x for y in F.pos_y ]
    [(1.0, -2.0), (1.0, 0.0), (1.0, 2.0), (1.5, -2.0), (1.5, 0.0), (1.5, 2.0), (2.0, -2.0), (2.0, 0.0), (2.0, 2.0)]


But in the following, the list is not the list of points::

    sage: x,y=var('x,y')
    sage: G=VectorField(x,y).graph(draw_points=[Point(1,2),Point(3,4)])
    sage: [ (x,y) for x in G.pos_x for y in G.pos_y ]
    [(1, 2), (1, 4), (3, 2), (3, 4)]
def phystricks.src.BasicGeometricObjects.VectorFieldGraph.pos_y (   self)
return the list of y positions on which there is a drawn vector

See pos_x

Member Data Documentation

phystricks.src.BasicGeometricObjects.VectorFieldGraph.draw_points
phystricks.src.BasicGeometricObjects.VectorFieldGraph.F
phystricks.src.BasicGeometricObjects.VectorFieldGraph.vector_field

The documentation for this class was generated from the following file: