Abstract class for creating a vtkUnstructuredGrid from sheaf field objects. More...

#include <vtk_abstract_grid_builder.h>

Inheritance diagram for tool::vtk_abstract_grid_builder:

Public Types
typedef sheaf::size_type	size_type

typedef sec_vd::dof_type	dof_type

Public Member Functions
virtual bool	is_ancestor_of (const any *other) const
	Conformance test; true if other conforms to this. More...

virtual vtk_abstract_grid_builder *	clone () const
	Virtual constructor, makes a new instance of the same type as this. More...

virtual vtk_abstract_grid_builder &	operator= (const vtk_abstract_grid_builder &xother)
	Assignment operator. More...

virtual bool	invariant () const
	Class invariant. More...

void	set_name_space (namespace_poset &xns)
	If this instance's namespace is not equal to xns, this instance is initialized to have namespace xns. More...

virtual	~vtk_abstract_grid_builder ()
	Destructor. More...

vtkUnstructuredGrid *	build (const sec_vd &xcoords, const sec_vd &xproperty)
	Builds a vtkUnstructuredGrid from xcoords and xproperty. More...

vtkUnstructuredGrid *	build (const sec_vd &xcoords, const sec_vd &xproperty1, const sec_vd &xproperty2)
	Builds a vtkUnstructuredGrid from xcoords, xproperty1, and xproperty2. More...

vtkUnstructuredGrid *	build (const sec_vd &xcoords)
	Builds a vtkUnstructuredGrid from xcoords only. More...

void	build_pa (const sec_vd &xcoords, const sec_vd &xproperty, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords and xproperty (pre-allocated version). More...

void	build_pa (const sec_vd &xcoords, const sec_vd &xproperty1, const sec_vd &xproperty2, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords, xproperty1, and xproperty2 (pre-allocated version). More...

void	build_pa (const sec_vd &xcoords, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords only with no property (pre-allocated version). The result is a reprecentation for the mesh only. More...

bool	use_point_top_ids () const
	If true use top ids to label points; otherwise, use discretization ids. More...

void	put_use_point_top_ids (bool xvalue)
	Sets use_point_top_ids() to xvalue. More...

bool	use_cell_top_ids () const
	If true use top ids to label cells; otherwise, use evaluation ids. More...

void	put_use_cell_top_ids (bool xvalue)
	Sets use_cell_top_ids() to xvalue. More...

vtkIdTypeArray *	vtk_pt_label_ids () const
	Array of top ids for points. More...

vtkIdTypeArray *	vtk_cell_label_ids () const
	Array of top ids for cells. More...

Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...

virtual	~any ()
	Destructor. More...

bool	invariant_check () const
	True if invariant checking is enabled. More...

void	enable_invariant_check () const
	Enable invariant checking. More...

void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...

int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...

Protected Member Functions
	vtk_abstract_grid_builder ()
	Defualt constructor. More...

Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Protected Attributes
bool	_use_point_top_ids
	If true use top ids to label points; otherwise, use discretization ids. More...

bool	_use_cell_top_ids
	If true use top ids to label cells; otherwise, use evaluation ids. More...

vtkIdTypeArray *	_vtk_pt_label_ids
	Array of top ids for points. More...

vtkIdTypeArray *	_vtk_cell_label_ids
	Array of top ids for cells. More...

Detailed Description

Abstract class for creating a vtkUnstructuredGrid from sheaf field objects.

Definition at line 72 of file vtk_abstract_grid_builder.h.

Constructor & Destructor Documentation

◆ ~vtk_abstract_grid_builder()

tool::vtk_abstract_grid_builder::~vtk_abstract_grid_builder ( )

virtual

Destructor.

Definition at line 151 of file vtk_abstract_grid_builder.cc.

References set_name_space().

Referenced by invariant().

◆ vtk_abstract_grid_builder()

tool::vtk_abstract_grid_builder::vtk_abstract_grid_builder ( )

protected

Defualt constructor.

Definition at line 385 of file vtk_abstract_grid_builder.cc.

Referenced by vtk_cell_label_ids().

Member Function Documentation

◆ build() [1/3]

vtkUnstructuredGrid * tool::vtk_abstract_grid_builder::build	(	const sec_vd &	xcoords,
		const sec_vd &	xproperty
	)

Builds a vtkUnstructuredGrid from xcoords and xproperty.

Precondition

xcoords.state_is_read_accessible()

xcoords.schema().base_space().schema().conforms_to(base_space_member::standard_schema_path())

xcoords.schema().df() <= 3

xproperty.state_is_read_accessible()

xproperty.schema().base_space().is_same_state(&xcoords.schema().base_space())

xproperty.schema().evaluation().is_same_state(&xcoords.schema().evaluation())

Definition at line 189 of file vtk_abstract_grid_builder.cc.

References fiber_bundle::section_space_schema_member::base_space(), sheaf::schema_poset_member::conforms_to(), fiber_bundle::section_space_schema_member::df(), fiber_bundle::section_space_schema_member::evaluation(), sheaf::poset_component::is_same_state(), sheaf::total_poset_member::schema(), fiber_bundle::sec_rep_space_member::schema(), fiber_bundle::base_space_member::standard_schema_path(), and sheaf::read_write_monitor_handle::state_is_read_accessible().

Referenced by build(), and set_name_space().

◆ build() [2/3]

vtkUnstructuredGrid * tool::vtk_abstract_grid_builder::build	(	const sec_vd &	xcoords,
		const sec_vd &	xproperty1,
		const sec_vd &	xproperty2
	)

Builds a vtkUnstructuredGrid from xcoords, xproperty1, and xproperty2.

Precondition

xcoords.state_is_read_accessible()

xcoords.schema().base_space().schema().conforms_to(base_space_member::standard_schema_path())

xcoords.schema().df() <= 3

xproperty1.state_is_read_accessible()

xproperty1.schema().base_space().is_same_state(&xcoords.schema().base_space())

xproperty1.schema().evaluation().is_same_state(&xcoords.schema().evaluation())

xproperty2.state_is_read_accessible()

xproperty2.schema().base_space().is_same_state(&xcoords.schema().base_space())

xproperty2.schema().evaluation().is_same_state(&xcoords.schema().evaluation())

Definition at line 219 of file vtk_abstract_grid_builder.cc.

References fiber_bundle::section_space_schema_member::base_space(), build(), sheaf::schema_poset_member::conforms_to(), fiber_bundle::section_space_schema_member::df(), fiber_bundle::section_space_schema_member::evaluation(), sheaf::poset_component::is_same_state(), sheaf::total_poset_member::schema(), fiber_bundle::sec_rep_space_member::schema(), fiber_bundle::base_space_member::standard_schema_path(), and sheaf::read_write_monitor_handle::state_is_read_accessible().

◆ build() [3/3]

vtkUnstructuredGrid * tool::vtk_abstract_grid_builder::build ( const sec_vd & xcoords )

Builds a vtkUnstructuredGrid from xcoords only.

Precondition

xcoords.state_is_read_accessible()

xcoords.schema().base_space().schema().conforms_to(base_space_member::standard_schema_path())

xcoords.schema().df() <= 3

Definition at line 252 of file vtk_abstract_grid_builder.cc.

References fiber_bundle::section_space_schema_member::base_space(), build_pa(), sheaf::schema_poset_member::conforms_to(), fiber_bundle::section_space_schema_member::df(), sheaf::total_poset_member::schema(), fiber_bundle::sec_rep_space_member::schema(), fiber_bundle::base_space_member::standard_schema_path(), and sheaf::read_write_monitor_handle::state_is_read_accessible().

◆ build_pa() [1/3]

void tool::vtk_abstract_grid_builder::build_pa	(	const sec_vd &	xcoords,
		const sec_vd &	xproperty,
		vtkUnstructuredGrid &	xresult
	)

Builds a vtkUnstructuredGrid from xcoords and xproperty (pre-allocated version).

Is Abstract.

Definition at line 279 of file vtk_abstract_grid_builder.cc.

Referenced by build(), and build_pa().

◆ build_pa() [2/3]

void tool::vtk_abstract_grid_builder::build_pa	(	const sec_vd &	xcoords,
		const sec_vd &	xproperty1,
		const sec_vd &	xproperty2,
		vtkUnstructuredGrid &	xresult
	)

Builds a vtkUnstructuredGrid from xcoords, xproperty1, and xproperty2 (pre-allocated version).

Is Abstract.

Definition at line 298 of file vtk_abstract_grid_builder.cc.

References build_pa().

◆ build_pa() [3/3]

void tool::vtk_abstract_grid_builder::build_pa	(	const sec_vd &	xcoords,
		vtkUnstructuredGrid &	xresult
	)

Builds a vtkUnstructuredGrid from xcoords only with no property (pre-allocated version). The result is a reprecentation for the mesh only.

Is Abstract.

Definition at line 318 of file vtk_abstract_grid_builder.cc.

References use_point_top_ids().

◆ clone()

tool::vtk_abstract_grid_builder * tool::vtk_abstract_grid_builder::clone ( ) const

virtual

Virtual constructor, makes a new instance of the same type as this.

Is Abstract.

Reimplemented from sheaf::any.

Reimplemented in tool::vtk_unstructured_grid_builder.

Definition at line 74 of file vtk_abstract_grid_builder.cc.

References operator=().

Referenced by is_ancestor_of().

◆ invariant()

bool tool::vtk_abstract_grid_builder::invariant ( ) const

virtual

Class invariant.

Invariant

any::invariant()

Reimplemented from sheaf::any.

Reimplemented in tool::vtk_unstructured_grid_builder.

Definition at line 117 of file vtk_abstract_grid_builder.cc.

References sheaf::any::invariant(), and ~vtk_abstract_grid_builder().

Referenced by tool::vtk_unstructured_grid_builder::invariant(), and operator=().

◆ is_ancestor_of()

bool tool::vtk_abstract_grid_builder::is_ancestor_of ( const any * other ) const

virtual

Conformance test; true if other conforms to this.

Precondition

other != 0

Reimplemented from sheaf::any.

Reimplemented in tool::vtk_unstructured_grid_builder.

Definition at line 51 of file vtk_abstract_grid_builder.cc.

References clone().

◆ operator=()

tool::vtk_abstract_grid_builder & tool::vtk_abstract_grid_builder::operator= ( const vtk_abstract_grid_builder & xother )

virtual

Assignment operator.

Is Abstract.

Postcondition

invariant()

Reimplemented in tool::vtk_unstructured_grid_builder.

Definition at line 95 of file vtk_abstract_grid_builder.cc.

References invariant().

Referenced by clone().

◆ put_use_cell_top_ids()

void tool::vtk_abstract_grid_builder::put_use_cell_top_ids ( bool xvalue )

Sets use_cell_top_ids() to xvalue.

Postcondition

use_cell_top_ids() == xvalue

Definition at line 361 of file vtk_abstract_grid_builder.cc.

References vtk_pt_label_ids().

Referenced by use_cell_top_ids().

◆ put_use_point_top_ids()

void tool::vtk_abstract_grid_builder::put_use_point_top_ids ( bool xvalue )

Sets use_point_top_ids() to xvalue.

Postcondition

use_point_top_ids() == xvalue

Definition at line 343 of file vtk_abstract_grid_builder.cc.

References use_cell_top_ids().

Referenced by use_point_top_ids().

◆ set_name_space()

void tool::vtk_abstract_grid_builder::set_name_space ( namespace_poset & xns )

If this instance's namespace is not equal to xns, this instance is initialized to have namespace xns.

Is Abstract.

Definition at line 171 of file vtk_abstract_grid_builder.cc.

References build().

Referenced by ~vtk_abstract_grid_builder().

◆ use_cell_top_ids()

bool tool::vtk_abstract_grid_builder::use_cell_top_ids ( ) const

If true use top ids to label cells; otherwise, use evaluation ids.

Definition at line 354 of file vtk_abstract_grid_builder.cc.

References put_use_cell_top_ids().

Referenced by put_use_point_top_ids().

◆ use_point_top_ids()

bool tool::vtk_abstract_grid_builder::use_point_top_ids ( ) const

If true use top ids to label points; otherwise, use discretization ids.

Definition at line 336 of file vtk_abstract_grid_builder.cc.

References put_use_point_top_ids().

Referenced by build_pa().

◆ vtk_cell_label_ids()

vtkIdTypeArray * tool::vtk_abstract_grid_builder::vtk_cell_label_ids ( ) const

Array of top ids for cells.

Definition at line 379 of file vtk_abstract_grid_builder.cc.

References vtk_abstract_grid_builder().

Referenced by vtk_pt_label_ids().

◆ vtk_pt_label_ids()

vtkIdTypeArray * tool::vtk_abstract_grid_builder::vtk_pt_label_ids ( ) const

Array of top ids for points.

Definition at line 372 of file vtk_abstract_grid_builder.cc.

References vtk_cell_label_ids().

Referenced by put_use_cell_top_ids().

Member Data Documentation

◆ _use_cell_top_ids

bool tool::vtk_abstract_grid_builder::_use_cell_top_ids

protected

If true use top ids to label cells; otherwise, use evaluation ids.

Definition at line 212 of file vtk_abstract_grid_builder.h.

◆ _use_point_top_ids

bool tool::vtk_abstract_grid_builder::_use_point_top_ids

protected

If true use top ids to label points; otherwise, use discretization ids.

Definition at line 206 of file vtk_abstract_grid_builder.h.

◆ _vtk_cell_label_ids

vtkIdTypeArray* tool::vtk_abstract_grid_builder::_vtk_cell_label_ids

protected

Array of top ids for cells.

Definition at line 222 of file vtk_abstract_grid_builder.h.

◆ _vtk_pt_label_ids

vtkIdTypeArray* tool::vtk_abstract_grid_builder::_vtk_pt_label_ids

protected

Array of top ids for points.

Definition at line 217 of file vtk_abstract_grid_builder.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~vtk_abstract_grid_builder()

◆ vtk_abstract_grid_builder()

Member Function Documentation

◆ build() [1/3]

◆ build() [2/3]

◆ build() [3/3]

◆ build_pa() [1/3]

◆ build_pa() [2/3]

◆ build_pa() [3/3]

◆ clone()

◆ invariant()

◆ is_ancestor_of()

◆ operator=()

◆ put_use_cell_top_ids()

◆ put_use_point_top_ids()

◆ set_name_space()

◆ use_cell_top_ids()

◆ use_point_top_ids()

◆ vtk_cell_label_ids()

◆ vtk_pt_label_ids()

Member Data Documentation

◆ _use_cell_top_ids

◆ _use_point_top_ids

◆ _vtk_cell_label_ids

◆ _vtk_pt_label_ids