Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify description of getMappingPointsWithinMesh #73

Open
p-j-smith opened this issue Aug 11, 2022 · 0 comments
Open

Clarify description of getMappingPointsWithinMesh #73

p-j-smith opened this issue Aug 11, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@p-j-smith
Copy link

getMappingPointsWithinMesh doesn't get all points that are inside the mesh, only points that are within a specified tolerance of the surface.

A more accurate name would be getMappingPointsOnMesh or getMappingPointsOnSurface.

Event if the name isn't changed to reflect this, it would be good to update the various parts of the description to something:

Update main description:

% GETMAPPINGPOINTSWITHINMESH Returns the indices of the mapping points
% which are located on the surface of the mesh

Add distance units to description of parameters:

% GETMAPPINGPOINTSWITHINMESH accepts the following parameter-value pairs
%   'tol' 0.1 | double
%       - The distance threshold (mm) within which points are considered to be
%         on the surface of the mesh 

Update return description:

% GETMAPPINGPOINTSWITHINMESH Returns the indices of the mapping points
% which are located on the surface of the mesh. The OpenEP function pointStatus.m
% is used to identify these points. The parameter value pairs are passed
% directly onto pointStatus.m
@p-j-smith p-j-smith added the documentation Improvements or additions to documentation label Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant