CGAL 6.3-dev - Homological Discrete Vector Fields
Loading...
Searching...
No Matches
CGAL::Homological_discrete_vector_field::Simplicial_chain_complex< CoefficientRing, Traits, SparseMatrixStruct > Class Template Reference

#include <CGAL/HDVF/Simplicial_chain_complex.h>

Inherits from

CGAL::Homological_discrete_vector_field::Abstract_simplicial_chain_complex< CoefficientRing, SparseMatrixStruct >.

Definition

template<typename CoefficientRing, typename Traits, typename SparseMatrixStruct = OSM::Sparse_matrix_structure<OSM::Sparse_chain>>
class CGAL::Homological_discrete_vector_field::Simplicial_chain_complex< CoefficientRing, Traits, SparseMatrixStruct >

The class Simplicial_chain_complex refines the Abstract_simplicial_chain_complex class by assigning coordinates to vertices (i.e. 0-simplices).

Hence, vtk output is available.

Is model of
GeometricChainComplex
Template Parameters
CoefficientRinga model of the IntegralDomainWithoutDivision concept.
Traitsa geometric traits class model of the HDVFTraits concept.
SparseMatrixStructa model of SparseMatrixStructure providing templates of sparse chains and sparse matrices built over a given model of SparseChain.

Public Types

typedef Traits::Point Point
 Type of vertex coordinates.
typedef Traits::Point3 Point3
 Type of vtk export vertex coordinates.
typedef Abstract_simplicial_chain_complex< CoefficientRing, SparseMatrixStruct > Base
 Type of parent Abstract_simplicial_chain_complex class.
Public Types inherited from CGAL::Homological_discrete_vector_field::Abstract_simplicial_chain_complex< CoefficientRing, SparseMatrixStruct >
typedef CoefficientRing Coefficient_ring
 Type of coefficients used to compute homology.
typedef SparseMatrixStruct Sparse_matrix_structure
 Type of sparse matrix structure used to compute homology.
template<typename _CR, int _SF>
using Sparse_chain_type = typename SparseMatrixStruct::template Sparse_chain_type<_CR, _SF>
 Type of sparse chain used to compute homology (derived from SparseMatrixStruct).
template<typename _CR, int _SF>
using Sparse_matrix_type = typename SparseMatrixStruct::template Sparse_matrix_type<_CR, _SF>
 Type of sparse matrix used to compute homology (derived from SparseMatrixStruct).
typedef Sparse_chain_type< Coefficient_ring, CGAL::OSM::COLUMN > Column_chain
 Type of column-major chains.
typedef Sparse_chain_type< Coefficient_ring, CGAL::OSM::ROW > Row_chain
 Type of row-major chains.
typedef Sparse_matrix_type< Coefficient_ring, CGAL::OSM::COLUMN > Column_matrix
 Type of column-major sparse matrices.

Public Member Functions

 Simplicial_chain_complex ()
 Default constructor: builds an empty simplicial complex.
 Simplicial_chain_complex (const Mesh_object_io< Traits > &mesh)
 Constructor from a Mesh_object_io.
Public Member Functions inherited from CGAL::Homological_discrete_vector_field::Abstract_simplicial_chain_complex< CoefficientRing, SparseMatrixStruct >
 Abstract_simplicial_chain_complex (int q=0)
 Default constructor (empty simplicial complex of dimension q).
template<typename Traits>
 Abstract_simplicial_chain_complex (const Mesh_object_io< Traits > &mesh)
 Constructor from a Mesh_object_io.
bool is_valid_simplex (const Simplex &simplex, int q) const
 Checks if simplex simplex of dimension q belongs to the complex.
Abstract_simplicial_chain_complex & operator= (const Abstract_simplicial_chain_complex &complex)
 Assignment.
const Simplex & index_to_cell (size_t i, int q) const
 Returns the simplex of index i in dimension q.
size_t cell_to_index (const Simplex &simplex) const
 Returns the index of a given simplex.
std::vector< size_t > bottom_faces (size_t id_cell, int q) const
 Returns the 0-simplices of a given simplex (that is, the indices of its 0-simplices).

Constructor & Destructor Documentation

◆ Simplicial_chain_complex()

template<typename CoefficientRing, typename Traits, typename SparseMatrixStruct = OSM::Sparse_matrix_structure<OSM::Sparse_chain>>
CGAL::Homological_discrete_vector_field::Simplicial_chain_complex< CoefficientRing, Traits, SparseMatrixStruct >::Simplicial_chain_complex ( const Mesh_object_io< Traits > & mesh)

Constructor from a Mesh_object_io.

Builds a simplicial complex from a Mesh_object_io describing maximal faces and vertex coordinates.

Exceptions
Invalid_geometryIf the `Mesh_object_io` mesh does not provide the right number of vertices coordinates, throws a `std::runtime_error` exception.