Creates a vtkUnstructuredGrid from sheaf field objects. More...

#include <vtk_unstructured_grid_builder.h>

Inheritance diagram for tool::vtk_unstructured_grid_builder:

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

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

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

vtk_unstructured_grid_builder &	operator= (const vtk_unstructured_grid_builder &xother)
	Assignment operator. More...

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

	vtk_unstructured_grid_builder ()
	Default constructor. More...

	vtk_unstructured_grid_builder (const vtk_unstructured_grid_builder &xother)
	Copy constructor. More...

	vtk_unstructured_grid_builder (namespace_poset &xns)
	Creates an instance for fields in namespace xns. More...

virtual	~vtk_unstructured_grid_builder ()
	Destructor. 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...

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

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

vtkUnstructuredGrid *	build (const sec_vd &xcoords)
	Builds a vtkUnstructuredGrid from xcoords, auto-allocated. More...

vtkUnstructuredGrid *	build (const sec_vd &xcoords, const std::string &xpartition_name)
	Builds a vtkUnstructuredGrid from xcoords with cells colored by membership in the partition with name xpartition_name, auto-allocated. More...

vtkUnstructuredGrid *	build (const sec_vd &xcoords, const block< sec_vd *> &xproperties)
	Builds a vtkUnstructuredGrid from xcoords and the property sections in xproperties, auto_allocated. More...

void	build_pa (const sec_vd &xcoords, const sec_vd &xproperty, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords and xproperty, pre-allocated. 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. More...

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

void	build_pa (const sec_vd &xcoords, const std::string &xpartition_name, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords with cells colored by membership in the partition with name xpartition_name, pre-allocated. More...

void	build_pa (const sec_vd &xcoords, const block< sec_vd *> &xproperties, vtkUnstructuredGrid &xresult)
	Builds a vtkUnstructuredGrid from xcoords and the property sections in xproperties, pre_allocated. More...

void	build_file (const sec_vd &xcoords, const sec_vd &xproperty, const std::string &xvtk_file_name, bool xis_ascii=true)
	Builds a vtk file representation of a vtkPolyData from xcoords and xproperty with file name xvtk_file_name. If xis_ascii is true, write an ascii (text) file; otherwise write a binary file. More...

bool	is_scalar (const sec_vd *xsec) const
	True if the fiber of xsec is a scalar type. More...

bool	is_vector (const sec_vd *xsec) const
	True if the fiber of xsec is a vector type. More...

bool	is_tensor (const sec_vd *xsec) const
	True if the fiber of xsec is a tensor type. More...

Public Member Functions inherited from tool::vtk_abstract_grid_builder
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...

Additional Inherited Members
Public Types inherited from tool::vtk_abstract_grid_builder
typedef sheaf::size_type	size_type

typedef sec_vd::dof_type	dof_type

Protected Member Functions inherited from tool::vtk_abstract_grid_builder
	vtk_abstract_grid_builder ()
	Defualt constructor. More...

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

Protected Attributes inherited from tool::vtk_abstract_grid_builder
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

Creates a vtkUnstructuredGrid from sheaf field objects.

Definition at line 41 of file vtk_unstructured_grid_builder.h.

Constructor & Destructor Documentation

◆ vtk_unstructured_grid_builder() [1/3]

tool::vtk_unstructured_grid_builder::vtk_unstructured_grid_builder ( )

Default constructor.

Definition at line 178 of file vtk_unstructured_grid_builder.cc.

Referenced by invariant(), and vtk_unstructured_grid_builder().

◆ vtk_unstructured_grid_builder() [2/3]

tool::vtk_unstructured_grid_builder::vtk_unstructured_grid_builder ( const vtk_unstructured_grid_builder & xother )

Copy constructor.

Not Implemented.

Postcondition

invariant()

Definition at line 195 of file vtk_unstructured_grid_builder.cc.

References vtk_unstructured_grid_builder().

◆ vtk_unstructured_grid_builder() [3/3]

tool::vtk_unstructured_grid_builder::vtk_unstructured_grid_builder ( namespace_poset & xns )

Creates an instance for fields in namespace xns.

Postcondition

invariant()

Definition at line 213 of file vtk_unstructured_grid_builder.cc.

References ~vtk_unstructured_grid_builder().

◆ ~vtk_unstructured_grid_builder()

tool::vtk_unstructured_grid_builder::~vtk_unstructured_grid_builder ( )

virtual

Destructor.

Definition at line 234 of file vtk_unstructured_grid_builder.cc.

References set_name_space().

Referenced by vtk_unstructured_grid_builder().

Member Function Documentation

◆ build() [1/5]

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

Builds a vtkUnstructuredGrid from xcoords and xproperty, auto_allocated.

Precondition

precondition_of(build_pa(xcoords, xproperty, result))

Postcondition

result != 0

postcondition_of(build_pa(xcoords, xproperty, result))

Definition at line 278 of file vtk_unstructured_grid_builder.cc.

Referenced by build(), and set_name_space().

◆ build() [2/5]

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

Builds a vtkUnstructuredGrid from xcoords, xproperty1, and xproperty2, auto_allocated.

Precondition

precondition_of(build_pa(xcoords, xproperty1, xproperty2, result))

Postcondition

result != 0

postcondition_of(build_pa(xcoords, xproperty1, xproperty2, result))

Definition at line 304 of file vtk_unstructured_grid_builder.cc.

References build().

◆ build() [3/5]

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

Builds a vtkUnstructuredGrid from xcoords, auto-allocated.

Precondition

precondition_of(build_pa(xcoords, result))

Postcondition

result != 0

postcondition_of(build_pa(xcoords, result))

Definition at line 330 of file vtk_unstructured_grid_builder.cc.

References build().

◆ build() [4/5]

vtkUnstructuredGrid * tool::vtk_unstructured_grid_builder::build	(	const sec_vd &	xcoords,
		const std::string &	xpartition_name
	)

Builds a vtkUnstructuredGrid from xcoords with cells colored by membership in the partition with name xpartition_name, auto-allocated.

Precondition

precondition_of(build_pa(xcoords, xparitition_name, result))

Postcondition

result != 0

postcondition_of(build_pa(xcoords, xparitition_name, result))

Definition at line 356 of file vtk_unstructured_grid_builder.cc.

References build().

◆ build() [5/5]

vtkUnstructuredGrid * tool::vtk_unstructured_grid_builder::build	(	const sec_vd &	xcoords,
		const block< sec_vd *> &	xproperties
	)

Builds a vtkUnstructuredGrid from xcoords and the property sections in xproperties, auto_allocated.

Precondition

precondition_of(build_pa(xcoords, xproperties, result))

Postcondition

result != 0

postcondition_of(build_pa(xcoords, xproperties, result))

Definition at line 382 of file vtk_unstructured_grid_builder.cc.

References build_pa().

◆ build_file()

void tool::vtk_unstructured_grid_builder::build_file	(	const sec_vd &	xcoords,
		const sec_vd &	xproperty,
		const std::string &	xvtk_file_name,
		bool	xis_ascii = `true`
	)

Builds a vtk file representation of a vtkPolyData from xcoords and xproperty with file name xvtk_file_name. If xis_ascii is true, write an ascii (text) file; otherwise write a binary file.

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())

!xvtk_file_name.empty()

Definition at line 1161 of file vtk_unstructured_grid_builder.cc.

Referenced by build_pa().

◆ build_pa() [1/5]

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

Builds a vtkUnstructuredGrid from xcoords and xproperty, pre-allocated.

Precondition

xcoords.state_is_read_accessible()

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

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

!xcoords.name().empty()

xproperty.state_is_read_accessible()

Hack:: a temporary restriction, until if below generalized.

Precondition

xproperty.is_jim()

Hack:: if the coordinates are a multi-section and the property is defined on some smaller chunk than the coordinates, we currently have no way to compute the vertex count for the restriction of the coordinates to the base space of the property. So:

Precondition

!xcoords.is_jim() ? xproperty.schema().same_base_space(xcoords.schema()) \ : true

Definition at line 408 of file vtk_unstructured_grid_builder.cc.

References sheaf::abstract_poset_member::attach_to_state(), fiber_bundle::section_space_schema_member::base_space(), fiber_bundle::sec_tuple::detach_from_state(), fiber_bundle::section_space_schema_member::df(), sheaf::DOWN, fiber_bundle::sec_vd::host(), sheaf::depth_first_iterator::index(), sheaf::depth_first_iterator::is_done(), sheaf::abstract_poset_member::is_jim(), sheaf::abstract_poset_member::le(), fiber_bundle::sec_rep_space::member_dof_map(), sheaf::abstract_poset_member::name(), tool::visualization_iterator::new_visualization_iterator(), sheaf::depth_first_iterator::next(), sheaf::NOT_STRICT, tool::visualization_iterator::put_anchor(), tool::visualization_iterator::put_use_cell_top_ids(), tool::visualization_iterator::put_use_point_top_ids(), tool::visualization_iterator::reset(), fiber_bundle::section_space_schema_member::same_base_space(), sheaf::total_poset_member::schema(), fiber_bundle::sec_rep_space_member::schema(), tool::visualization_iterator::set_vtk_data(), fiber_bundle::base_space_member::standard_schema_path(), and sheaf::read_write_monitor_handle::state_is_read_accessible().

Referenced by build(), and build_pa().

◆ build_pa() [2/5]

void tool::vtk_unstructured_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.

Precondition

xcoords.state_is_read_accessible()

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

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

!xcoords.name().empty()

xproperty1.state_is_read_accessible()

xproperty2.state_is_read_accessible()

Hack:: a temporary restriction, until if below generalized.

Precondition

xproperty1.is_jim()

xproperty2.is_jim()

Hack:: if the coordinates are a multi-section and the property is defined on some smaller chunk than the coordinates, we currently have no way to compute the vertex count for the restriction of the coordinates to the base space of the property. So:

Precondition

!xcoords.is_jim() ? xproperty1.schema().same_base_space(xcoords.schema()) : true

!xcoords.is_jim() ? xproperty2.schema().same_base_space(xcoords.schema()) : true

Definition at line 562 of file vtk_unstructured_grid_builder.cc.

References fiber_bundle::section_space_schema_member::base_space(), build_pa(), fiber_bundle::section_space_schema_member::df(), sheaf::abstract_poset_member::is_jim(), sheaf::abstract_poset_member::name(), sheaf::auto_block< T, un_block_initialization_policy< T > >::push_back(), fiber_bundle::section_space_schema_member::same_base_space(), 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() [3/5]

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

Builds a vtkUnstructuredGrid from xcoords, pre-allocated.

Precondition

xcoords.state_is_read_accessible()

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

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

!xcoords.name().empty()

Definition at line 615 of file vtk_unstructured_grid_builder.cc.

◆ build_pa() [4/5]

void tool::vtk_unstructured_grid_builder::build_pa	(	const sec_vd &	xcoords,
		const std::string &	xpartition_name,
		vtkUnstructuredGrid &	xresult
	)

Builds a vtkUnstructuredGrid from xcoords with cells colored by membership in the partition with name xpartition_name, pre-allocated.

Precondition

xcoords.state_is_read_accessible()

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

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

!xpartition_name.empty()

xcoords.schema().base_space().host()->member_id_spaces(true).contains(xpartition_name)

Definition at line 724 of file vtk_unstructured_grid_builder.cc.

References fiber_bundle::section_space_schema_member::base_space(), build_pa(), sheaf::schema_poset_member::conforms_to(), sheaf::index_space_family::contains(), fiber_bundle::section_space_schema_member::df(), sheaf::poset_component::host(), sheaf::poset_state_handle::member_id_spaces(), 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() [5/5]

void tool::vtk_unstructured_grid_builder::build_pa	(	const sec_vd &	xcoords,
		const block< sec_vd *> &	xproperties,
		vtkUnstructuredGrid &	xresult
	)

Builds a vtkUnstructuredGrid from xcoords and the property sections in xproperties, pre_allocated.

Precondition

xcoords.state_is_read_accessible()

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

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

!xcoords.name().empty()

xproperties.ct() > 0

for(int i = ( 0 ); i < ( xproperties.ct() ); ++ i ) xproperties[i]->state_is_read_accessible()

Hack:: a temporary restriction, until if below generalized.

Precondition

for(int i = ( 0 ); i < ( xproperties.ct() ); ++ i ) xproperties[i]->is_jim()

Hack:: if the coordinates are a multi-section and the property is defined on some smaller chunk than the coordinates, we currently have no way to compute the vertex count for the restriction of the coordinates to the base space of the property. So:

Precondition