Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds comprehensive documentation for several methods in the
FEDOF_class, which is part of a finite element framework. These methods are crucial for understanding and manipulating finite element degrees of freedom (DOFs), including operations like copying, deallocating, retrieving interpolation types, and accessing connectivity information. The documentation includes detailed interfaces, parameter descriptions, implementation details, usage examples, and related methods for each function.New Method Documentation
Core Functionality:
Copy: Describes how to perform a shallow copy of oneFEDOF_object to another, including copying basic properties, associating mesh pointers, and handling array data.Deallocate: Explains how to release allocated memory and reset aFEDOF_object to its default state, ensuring proper memory management.Interpolation and Case Identification:
GetBaseInterpolation: Provides details on retrieving the type of basis functions (e.g., Lagrange, Hierarchical) used for interpolation in aFEDOF_instance.GetCaseName: Documents how to obtain a unique identifier combining continuity and interpolation type, used for algorithm selection.Connectivity and DOF Operations:
GetCellDOF: Explains how to retrieve the DOFs associated with a specific cell in the mesh, including optional local/global element handling.GetCellOrder: Details how to retrieve the polynomial order of a specific cell, critical for p-adaptive finite element methods.GetConnectivity: Describes how to retrieve global DOFs for a specified element, supporting filtering by entity type (e.g., vertices, edges).GetConnectivity_: Provides a lower-level interface for retrieving connectivity information, offering more control over memory allocation.