Skip to content
Snippets Groups Projects
Commit a17902ac authored by Tom Fischer's avatar Tom Fischer
Browse files

[ML] Made documentation correct / more clear.

parent 3dc59320
No related branches found
No related tags found
No related merge requests found
......@@ -32,7 +32,7 @@ namespace MeshLib
/// @brief Material property manager on mesh items.
/// Class Properties manages scalar, vector or matrix properties. For instance
/// in groundwater flow porosity is scalar property and permeabilty can be
/// in groundwater flow porosity is a scalar property and permeabilty can be
/// stored as a tensor property. Properties are assigned to mesh items, i.e.
/// Node or Element objects. The newProperty() method first creates a
/// PropertyVector of template type T (scalar, vector or matrix).
......@@ -79,8 +79,9 @@ public:
/// Method creates a PropertyVector if a PropertyVector with the same name
/// and the same type T was not already created before.
/// This method is used if only a small number of different properties
/// exists. In this case a mapping between mesh items and properties (stored
/// This method is used if only a small number of distinct property values
/// in a property exist (e.g. mapping material groups to elements).
/// In this case a mapping between mesh items and properties (stored
/// on the heap), see the parameter item2group_mapping, is required.
/// @tparam T type of the property value
/// @param name the name of the property
......
......@@ -41,7 +41,7 @@ public:
/// The behaviour has changed for the constructor, destructor and the operator[].
/// The user has to provide the size and an item to group mapping for construction.
/// The destructor takes care to delete the entries of the vector.
/// The operator[] uses an item to group property map to access to the
/// The operator[] uses an item-to-group property map to access the
/// correct property.
/// \tparam T pointer type, the type the type points to is typical a scalar,
/// a vector or a matrix type
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment