hodge_decomposition.h

/*
 * Copyright 2026 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
#pragma once
 
#include <lagrange/SurfaceMesh.h>
#include <lagrange/polyddg/DifferentialOperators.h>
#include <lagrange/polyddg/api.h>
 
#include <cstdint>
#include <string_view>
 
namespace lagrange::polyddg {


struct HodgeDecompositionOptions
{
    double lambda = 1.0;

    uint8_t nrosy = 1;

    std::string_view input_attribute = "@hodge_input";

    std::string_view exact_attribute = "@hodge_exact";

    std::string_view coexact_attribute = "@hodge_coexact";

    std::string_view harmonic_attribute = "@hodge_harmonic";
};

struct HodgeDecompositionResult
{
    AttributeId exact_id = invalid_attribute_id();

    AttributeId coexact_id = invalid_attribute_id();

    AttributeId harmonic_id = invalid_attribute_id();
};
 
// ---- 1-form level -----------------------------------------------------------

template <typename Scalar, typename Index>
LA_POLYDDG_API HodgeDecompositionResult hodge_decomposition_1_form(
    SurfaceMesh<Scalar, Index>& mesh,
    const DifferentialOperators<Scalar, Index>& ops,
    HodgeDecompositionOptions options = {});

template <typename Scalar, typename Index>
LA_POLYDDG_API HodgeDecompositionResult hodge_decomposition_1_form(
    SurfaceMesh<Scalar, Index>& mesh,
    HodgeDecompositionOptions options = {});
 
// ---- Per-vertex vector field level ------------------------------------------

template <typename Scalar, typename Index>
LA_POLYDDG_API HodgeDecompositionResult hodge_decomposition_vector_field(
    SurfaceMesh<Scalar, Index>& mesh,
    const DifferentialOperators<Scalar, Index>& ops,
    HodgeDecompositionOptions options = {});

template <typename Scalar, typename Index>
LA_POLYDDG_API HodgeDecompositionResult hodge_decomposition_vector_field(
    SurfaceMesh<Scalar, Index>& mesh,
    HodgeDecompositionOptions options = {});

 
} // namespace lagrange::polyddg