Lagrange
Loading...
Searching...
No Matches
HodgeDecompositionOptions Struct Reference

Options for Hodge decomposition functions. More...

#include <lagrange/polyddg/hodge_decomposition.h>

Public Attributes

double lambda = 1.0
 Stabilization weight \( \lambda \) for the VEM 1-form inner product.
 
uint8_t nrosy = 1
 N-rosy symmetry order.
 
std::string_view input_attribute = "@hodge_input"
 Input attribute name.
 
std::string_view exact_attribute = "@hodge_exact"
 Output attribute name for the exact component.
 
std::string_view coexact_attribute = "@hodge_coexact"
 Output attribute name for the co-exact component.
 
std::string_view harmonic_attribute = "@hodge_harmonic"
 Output attribute name for the harmonic component.
 

Detailed Description

Options for Hodge decomposition functions.

Depending on which function is passed this argument, the attributes are interpreted differently:

  • For hodge_decomposition_1_form(): input/output are per-edge scalars (1-forms)
  • For hodge_decomposition_vector_field(): input/output are per-vertex 3D vectors (vector fields)

Member Data Documentation

◆ nrosy

uint8_t nrosy = 1

N-rosy symmetry order.

Only used by hodge_decomposition_vector_field(). When n = 1 (default) the input is a plain vector field. When n > 1 the input is one representative vector of an n-rosy field. The vector is encoded in the local tangent plane via n-fold angle multiplication before the 1-form decomposition and decoded back afterwards.

◆ input_attribute

std::string_view input_attribute = "@hodge_input"

Input attribute name.

  • For hodge_decomposition_1_form(): per-edge scalar (1-form)
  • For hodge_decomposition_vector_field(): per-vertex 3D vector (global coordinates)

◆ exact_attribute

std::string_view exact_attribute = "@hodge_exact"

Output attribute name for the exact component.

  • For hodge_decomposition_1_form(): per-edge scalar
  • For hodge_decomposition_vector_field(): per-vertex 3D vector (global coordinates)

◆ coexact_attribute

std::string_view coexact_attribute = "@hodge_coexact"

Output attribute name for the co-exact component.

  • For hodge_decomposition_1_form(): per-edge scalar
  • For hodge_decomposition_vector_field(): per-vertex 3D vector (global coordinates)

◆ harmonic_attribute

std::string_view harmonic_attribute = "@hodge_harmonic"

Output attribute name for the harmonic component.

  • For hodge_decomposition_1_form(): per-edge scalar
  • For hodge_decomposition_vector_field(): per-vertex 3D vector (global coordinates)

The documentation for this struct was generated from the following file: