Skip to content

Conversation

@vickysharma0812
Copy link
Member

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 one FEDOF_ object to another, including copying basic properties, associating mesh pointers, and handling array data.
  • Deallocate: Explains how to release allocated memory and reset a FEDOF_ 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 a FEDOF_ 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.

@vickysharma0812 vickysharma0812 self-assigned this Jun 10, 2025
@vickysharma0812 vickysharma0812 added documentation Improvements or additions to documentation fedof labels Jun 10, 2025
@vickysharma0812 vickysharma0812 merged commit 54c2cc0 into dev Jun 10, 2025
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 fedof

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants