geomodel_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2017, Association Scientifique pour la Geologie et ses
 * Applications (ASGA). All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of ASGA nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ASGA BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *     http://www.ring-team.org
 *
 *     RING Project
 *     Ecole Nationale Superieure de Geologie - GeoRessources
 *     2 Rue du Doyen Marcel Roubault - TSA 70605
 *     54518 VANDOEUVRE-LES-NANCY
 *     FRANCE
 */

#pragma once

#include <ringmesh/basic/common.h>

namespace RINGMesh
{
    class MeshEntityType;
    class GeologicalEntityType;
    FORWARD_DECLARATION_DIMENSION_CLASS( GeoModel );

    ALIAS_3D( GeoModel );
} // namespace RINGMesh

namespace RINGMesh
{
    template < index_t DIMENSION >
    void print_geomodel( const GeoModel< DIMENSION >& geomodel );

    template < index_t DIMENSION >
    void print_geomodel_mesh_stats( const GeoModel< DIMENSION >& geomodel );

    void RINGMESH_API print_geomodel_mesh_cell_volumes(
        const GeoModel3D& geomodel );

    template < index_t DIMENSION >
    index_t find_mesh_entity_id_from_name(
        const GeoModel< DIMENSION >& geomodel,
        const MeshEntityType& gmme_type,
        const std::string& name );

    template < index_t DIMENSION >
    index_t find_geological_entity_id_from_name(
        const RINGMesh::GeoModel< DIMENSION >& geomodel,
        const RINGMesh::GeologicalEntityType& gmge_type,
        const std::string& name );

#ifdef RINGMESH_WITH_TETGEN

    void RINGMESH_API tetrahedralize( GeoModel3D& geomodel,
        const std::string& method = "TetGen",
        index_t region_id = NO_ID,
        bool add_steiner_points = true );

    void RINGMESH_API tetrahedralize( GeoModel3D& geomodel,
        const std::string& method,
        index_t region_id,
        bool add_steiner_points,
        const std::vector< std::vector< vec3 > >& internal_vertices );

#endif

    template < index_t DIMENSION >
    void translate( GeoModel< DIMENSION >& geomodel,
        const vecn< DIMENSION >& translation_vector );

    void RINGMESH_API rotate( GeoModel3D& geomodel,
        const vec3& origin,
        const vec3& axis,
        double angle,
        bool degrees = false );
} // namespace RINGMesh