VectorField

Navigation: Up, Table of Contents, Short Table of Contents, Package Overview, Bibliography, Index, Title Page

VectorField_2

Definition

The concept VectorField_2 describes the set of requirements to be fulfilled by any class used to instantiate the first template parameter of the class Stream_lines_2<VectorField_2,Integrator_2>. This concept provides the types of the geometric primitives used in the placement of streamlines and some functions for answering different queries.

Types

VectorField_2::Geom_traits
	The traits class.
VectorField_2::FT
	The scalar type.
VectorField_2::Point_2
	The point type.
VectorField_2::Vector_2
	The vector type.

Creation

VectorField_2 vfield;
	Any constructor has to allow the user to fill the vector values (i.e. assign a vector to each position witin the domain).

Query Functions

Geom_traits::Iso_rectangle_2
vfield.bbox () returns the bounding box of the whole domain.

std::pair<Vector_2,FT>
vfield.get_field ( Point_2 p)
returns the vector field value and the local density.
Precondition: is_in_domain(p) must be true.

bool vfield.is_in_domain ( Point_2 p)
returns true if the point p is inside the domain boundaries, false otherwise.

FT vfield.get_integration_step ( Point_2 p)
returns the integration step at the point p (i.e. the distance between p and the next point in the polyline.).
Precondition: is_in_domain(p) must be true.

Has Models

CGAL::Regular_grid_2<StreamLinesTraits_2>
CGAL::Triangular_field_2<StreamLinesTraits_2>

Navigation: Up, Table of Contents, Short Table of Contents, Package Overview, Bibliography, Index, Title Page

CGAL Open Source Project. Release 3.2.1. 13 July 2006.

Geom_traits::Iso_rectangle_2
	vfield.bbox ()	returns the bounding box of the whole domain.
std::pair<Vector_2,FT>
	vfield.get_field ( Point_2 p)
		returns the vector field value and the local density. Precondition: is_in_domain(p) must be true.
bool	vfield.is_in_domain ( Point_2 p)
		returns true if the point p is inside the domain boundaries, false otherwise.
FT	vfield.get_integration_step ( Point_2 p)
		returns the integration step at the point p (i.e. the distance between p and the next point in the polyline.). Precondition: is_in_domain(p) must be true.