GEOMLib

Author: precsim

.gitattributes

@@ -0,0 +1,4 @@
+*.html linguist-detectable=false
+*.js   linguist-detectable=false
+*.md   linguist-detectable=false
+*.xml  linguist-detectable=false

LICENSE

@@ -0,0 +1,132 @@
+GEOMLib - 3D CSG Geometry Library for MATLAB® and GNU Octave
+============================================================
+
+**GEOMLib** is a 2D and 3D geometry library for MATLAB® and GNU Octave
+allowing _mesh based_ CSG (Composite Solid Geometry) operations.
+
+Originally developed for use with the [FEATool Multiphysics](https://www.featool.com)
+FEA simulation toolbox, but now replaced with the OpenCASCADE geometry
+kernel to support BREP CAD geometry support.
+
+![GEOMLib - MATLAB CSG Geometry Library](geomlib-screenshot.jpg)
+
+
+Installation
+------------
+
+Download and copy the library to a folder. Start MATLAB® or Octave and
+start the `runtests` script (or `runtests 1` for verbose output) to
+run the test and validation suite.
+
+
+Examples
+--------
+
+1. 2D example of the union of a circle and unit square
+
+        % Create circle
+        c1 = gobj_circle([0, 0], 0.5, 'C1');
+        c1 = convert_gobj_polygons( c1, 1 );
+        c1 = csg_op( c1, 'b' );
+
+        % Create unit square
+        r1 = gobj_rectangle(0, 1, 0, 1, 'R1');
+        r1 = convert_gobj_polygons( r1, 2 );
+        r1 = csg_op( r1, 'b' );
+
+        % Join circle and square
+        [res,~,stat] = csg_op( c1, r1, '+' );
+
+        % Visualize result
+        csg_op(res, 'v')
+
+2. 3D subtraction of a sphere from a unit cube
+
+        % Create sphere
+        s1 = gobj_sphere([0, 0, 1], 0.5, 'S1');
+        s1 = convert_gobj_polygons( s1, 1 );
+        s1 = csg_op( s1, 'b' );
+
+        % Create unit cube
+        b1 = gobj_block(0, 1, 0, 1, 0, 1, 'B1');
+        b1 = convert_gobj_polygons( b1, 2 );
+        b1 = csg_op( b1, 'b' );
+
+        % Subtracting sphere from cube
+        [res,~,stat] = csg_op( b1, s1, '-' );
+
+        % Visualize result
+        csg_op(res, 'v')
+
+3. For more examples see the tests in the _test_ directory.
+
+
+Functions
+---------
+
+    % Main CSG functions:
+
+    csg_op - apply CSG operation on polygons
+    csg_polygon_recombination - recombine and tessellate polygons
+    csg_polygon_tesselation - recombine and tessellate polygons
+
+    % Geometry object primitives:
+
+    gobj_block - create block
+    gobj_circle - create circle
+    gobj_cylinder - create cylinder
+    gobj_ellipse - create ellipse
+    gobj_polygon - create polygon
+    gobj_rectangle - create rectangle
+    gobj_sphere - create sphere
+
+    % Geometry utility and help functions:
+
+    convert_gobj_polygons - extract polygons from geometry object
+    deduplicate - remove duplicate rows or columns within tolerance
+    uunique - unsorted set unique
+
+
+Support
+-------
+
+This library has been open sourced on an _as is_ basis under the
+AGPLv3 License (see included LICENSE file) without warranty or
+support.
+
+For technical support, consulting, and custom development of this
+library, commercial licensing, or use of the newer OpenCASCADE based
+geometry library (allowing BREP CAD geometry modeling such as STEP and
+IGES formats) please [contact Precise
+Simulation](https://www.precisesimulation.com#contact) directly.
+
+
+License
+-------
+
+Copyright (C) 2013-2022 Precise Simulation Ltd.
+
+Keywords: Geometry, CSG, Mesh, MATLAB®, Octave
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of version 3 of the GNU Affero General Public
+License (AGPLv3) as published by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public
+License along with this program. If not, see
+[http://www.gnu.org/licenses](http://www.gnu.org/licenses).
+
+
+Trademarks
+----------
+
+FEATool Multiphysics™ is a trademark of Precise Simulation
+Limited. MATLAB® is a registered trademark of The MathWorks, Inc. All
+other trademarks are the property of their respective owners. Precise
+Simulation and its products are not affiliated with, endorsed, or
+sponsored by these trademark owners.

README.md

@@ -0,0 +1,51 @@
+function [ results ] = runtests( varargin )
+%RUNTESTS Runs the testsuite
+%
+% [ RESULTS ] = RUNTESTS( VARARGIN ) Runs the test suite (VERBOSELY if
+% any input argument is given). To run a single test suite/case enter
+% the testSuite:testCase can be specified as an argument. If two input
+% arguments are given verbose tests are run and output to the file
+% given by the second argument. RESULTS is a NTESTSUITES x 2 array
+% with the number of passed tests in first column and failed in second.
+
+% The SSRCDIR with source files (which are added to the path) and
+% STESTDIR with mloct_test files are specified manually below.
+
+% Initial version 180216.
+% Copyright 2013-2022 Precise Simulation Ltd.
+% License: AGPL v3, see LICENSE for more details or contact
+%          Precise Simulation for alternative licensing options.
+
+sSrcDir   = 'src';
+sTestDir  = 'test';
+sTest     = '';
+fid       = 1;
+isVerbose = false;
+
+
+if( nargin>=1 )
+  arg1 = varargin{1};
+  isVerbose = true;
+  if( ischar(arg1) && length(arg1)>1 )
+    sTest = arg1;
+  end
+
+  if( nargin>=2 )
+    arg2 = varargin{2};
+    if( ischar(arg2) )
+      fid = fopen( arg2, 'a+' );
+    end
+  end
+end
+addpath( genpath('test/mloct_test') );
+
+
+results = mloct_test_run( sSrcDir, sTestDir, sTest, fid, isVerbose );
+
+
+if( fid>1 )
+  fclose( fid );
+end
+if( ~nargout )
+  clear results
+end

geomlib-screenshot.jpg

@@ -0,0 +1,77 @@
+function [ polygons ] = convert_gobj_polygons( gobj, id )
+%CONVERT_GOBJ_POLYGONS Constructs polygons from geometry object.
+%
+%   [ POLYGONS ] = CONVERT_GOBJ_POLYGONS( GOBJ, ID ) Constructs
+%   polygons from the boundaries of geometry object GOBJ by calling
+%   the CSG_OP build operation. ID if present will be appended to the
+%   polygon id property. Thus the final polygon identity field will
+%   consist of the local boundary number, local polygon number, and ID.
+
+% Initial version 171228.
+% Copyright 2013-2022 Precise Simulation Ltd.
+% License: AGPL v3, see LICENSE for more details or contact
+%          Precise Simulation for alternative licensing options.
+if( ~(nargin || nargout) ),help convert_gobj_polygons, return, end
+
+if( nargin<2 || ~isnumeric(id) )
+  id = 0;
+end
+
+
+if( isfield(gobj,'boundaries') )
+
+  polygons = {};
+  boundaries = gobj.boundaries;
+  for i_bdr=1:length(boundaries)
+    polygons_ibdr = boundary_to_polygons( boundaries(i_bdr), [i_bdr,id] );
+    polygons = [ polygons, polygons_ibdr ];
+  end
+
+elseif( isfield(gobj,'edges') || isfield(gobj,'faces') )   % Input is boundary struct.
+
+  polygons = boundary_to_polygons( gobj, id );
+
+else
+  error( 'Could not create polygons from geometry object.' )
+end
+
+%------------------------------------------------------------------------------%
+function [ polygons ] = boundary_to_polygons( boundary, id )
+
+polygons = {};
+if( isfield(boundary,'vertices') && isfield(boundary,'faces') )
+
+  vertices = boundary.vertices;
+  faces = boundary.faces;
+  if( ~iscell(faces) )
+    faces = { faces };
+  end
+
+  i_cnt = 0;
+  for i=1:length(faces)
+    f = faces{i};
+    for j=1:size(f,1)
+      v = vertices(f(j,:),:);
+      i_cnt = i_cnt + 1;
+      identity = [i_cnt,id];
+
+      polygon_i = csg_op( v, identity, 'b' );
+      polygons  = [ polygons, polygon_i ];
+    end
+  end
+
+elseif( isfield(boundary,'edges') )
+
+  p_e = boundary.edges;
+  n_e = size(p_e,1) - 1;
+  for i=1:n_e
+    v = p_e([i,i+1],:);
+    identity = [i,id];
+
+    polygon_i = csg_op( v, identity, 'b' );
+    polygons  = [ polygons, polygon_i ];
+  end
+
+else
+  error( 'Could not create polygons from boundary.' )
+end