From a79f05eafee8dbdcc2c376c5876fe06e61cc97ed Mon Sep 17 00:00:00 2001 From: Bernd Hahnebach Date: Mon, 23 Sep 2019 21:16:49 +0200 Subject: [PATCH] FEM: typos --- src/Mod/Fem/App/FemAnalysis.h | 8 ++++---- src/Mod/Fem/App/FemConstraint.h | 20 ++++++++++---------- src/Mod/Fem/femtools/femutils.py | 16 ++++++++-------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/Mod/Fem/App/FemAnalysis.h b/src/Mod/Fem/App/FemAnalysis.h index 797a61d8c2..7e82ddb92b 100644 --- a/src/Mod/Fem/App/FemAnalysis.h +++ b/src/Mod/Fem/App/FemAnalysis.h @@ -34,15 +34,15 @@ namespace Fem { * @brief Container of objects relevant to one simulation. * * @details - * A Analysis contains all objects nessesary for a complete specification + * A Analysis contains all objects necessary for a complete specification * of a simulation. After computing it also contains the result of the - * simulation. The Analysis object is just a container. It is not reponsible + * simulation. The Analysis object is just a container. It is not responsible * for anything else like executing the simulation. * * The Analysis class is essentially a App::DocumentObjectGroup. It handles * all the container stuff. The difference is that the Analysis document * object uses a different ViewProvider, has a Uid property and does some - * compability handling via handleChangedPropertyName. + * compatibility handling via handleChangedPropertyName. * * This implies that it is not checked which objects are put into the * Analsis object. Every document object of FreeCAD can be part of a @@ -73,7 +73,7 @@ public: protected: /** - * @brief Retain compability with old "Member" property. + * @brief Retain compatibility with old "Member" property. * * @details * In an older version of FreeCAD FemAnalysis handles it's member itself diff --git a/src/Mod/Fem/App/FemConstraint.h b/src/Mod/Fem/App/FemConstraint.h index a28e029d08..b4270b1afe 100644 --- a/src/Mod/Fem/App/FemConstraint.h +++ b/src/Mod/Fem/App/FemConstraint.h @@ -40,7 +40,7 @@ namespace Fem { * used to specify a simulation are children of this class. The base class * essentially does two things: Most importantely it has a property @ref * Constraint::References which is a list of all sub objects the constraint - * applys to. Defining it in the base class exposes a common interface to code + * applies to. Defining it in the base class exposes a common interface to code * using different constraints. * * The second purpose of @ref Constraint is to support the redering to the @@ -146,7 +146,7 @@ public: * This is just used to make code more understandable. Other versions * (overloads) of this function do useful calculations based on faces or * edges. Used by @ref getPoints if no useful shape information is - * avaliable. + * available. * * @return always the integer 1 */ @@ -167,7 +167,7 @@ protected: * @brief Triggers @ref onChanged to update View Provider. * * @note - * This should not be nessesary and is properly a bug in the View Provider + * This should not be necessary and is properly a bug in the View Provider * of FemConstraint. */ virtual void onDocumentRestored(); @@ -203,7 +203,7 @@ protected: * * @return * If the calculation of points, normals and scale was successful it - * returns true. If an error occured and the data couldn't be extracted + * returns true. If an error occurred and the data couldn't be extracted * properly false is returned. */ bool getPoints( @@ -215,8 +215,8 @@ protected: * @brief Extract properties of cylindrical face. * * @note - * This method is very specific and doesn't requre access to member - * variables. It should be rewritten at a different palce. + * This method is very specific and doesn't require access to member + * variables. It should be rewritten at a different place. */ bool getCylinder( double& radius, double& height, @@ -226,8 +226,8 @@ protected: * @brief Calculate point of cylidrical face where to render widget. * * @note - * This method is very specific and doesn't requre access to member - * variables. It should be rewritten at a different palce. + * This method is very specific and doesn't require access to member + * variables. It should be rewritten at a different place. */ Base::Vector3d getBasePoint(const Base::Vector3d& base, const Base::Vector3d& axis, const App::PropertyLinkSub &location, const double& dist); @@ -235,8 +235,8 @@ protected: * @brief Get normal vector of point calculated by @ref getBasePoint. * * @note - * This method is very specific and doesn't requre access to member - * variables. It should be rewritten at a different palce. + * This method is very specific and doesn't require access to member + * variables. It should be rewritten at a different place. */ const Base::Vector3d getDirection(const App::PropertyLinkSub &direction); }; diff --git a/src/Mod/Fem/femtools/femutils.py b/src/Mod/Fem/femtools/femutils.py index c2af8d5062..3d61d7b8e6 100644 --- a/src/Mod/Fem/femtools/femutils.py +++ b/src/Mod/Fem/femtools/femutils.py @@ -22,7 +22,7 @@ # *************************************************************************** """ Collection of functions for the Fem module. -This module contains function for managing a analysis and all the differnet +This module contains function for managing a analysis and all the different types of objects it contains, helper for executing a simulation, function for extracting relevant parts of geometry and a few unrelated function useful at various places in the Fem module. @@ -103,7 +103,7 @@ def get_member(analysis, t): Search *analysis* for members of type *t*. This method checks the custom python typesytem (BaseType class property) used by the Fem module if - possible. If the object doens't use the python typesystem the usual + possible. If the object does not use the python typesystem the usual isDerivedFrom from the C++ dynamic type system is used. :param analysis: only objects part of this analysis are considered @@ -170,8 +170,8 @@ def get_several_member(analysis, t): which is empty. :note: - Undefined behaviour if the type of the references of one object arn't all - the same. + Undefined behaviour if the type of the references of one object are not + all the same. :note: Inheritance of Fem types is not checked. If *obj* uses Fems typesystem the @@ -408,7 +408,7 @@ def getSelectedFace(selectionex): """ Return selected face if exactly one face is selected. :returns: - The selcted face as a ``Part::TopoShape`` if exactly one face is selected. + The selected face as a ``Part::TopoShape`` if exactly one face is selected. Otherwise return ``None``. :param selectionex: @@ -446,11 +446,11 @@ def get_refshape_type(fem_doc_object): :returns: A string representing the shape type ("Vertex", "Edge", "Face" or - "Solid"). If *fem_doc_object* isn't a contraint ``""`` is returned. + "Solid"). If *fem_doc_object* isn't a constraint ``""`` is returned. :note: - Undefined behaviour if the type of the references of one object arn't all - the same. + Undefined behaviour if the type of the references of one object are + not all the same. :note: Undefined behaviour if constraint contains no references (empty list).