GridapROMs.Utils

const ArrayContribution{T,N} = Contribution{<:Union{AbstractArray{T,N},ArrayBlock{T,N}}}

Contribution whose field values are AbstractArrays

struct Contribution{V}
  values::Tuple{Vararg{V}}
  trians::Tuple{Vararg{Triangulation}}
end

Collection of values corresponding to a set of triangulations. Similarly to DomainContribution, the values can be accessed by indexing the corresponding triangulation.

struct FEDomains{A,B}
  domains_res::A
  domains_jac::B
end

Fields:

• domains_res: triangulations relative to the residual (nothing by default)
• domains_jac: triangulations relative to the Jacobian (nothing by default)

struct JointDomains <: TriangulationStyle end

Trait for a FE operator indicating that residuals/Jacobians in this operator should be computed summing the contributions relative to each triangulation as occurs in Gridap

const MatrixContribution{T} = ArrayContribution{T,2}

struct PartialDerivative{N} <: Function end

Gridap Map that implements a partial derivative

struct SplitDomains <: TriangulationStyle end

Trait for a FE operator indicating that residuals/Jacobians in this operator should be computed keeping the contributions relative to each triangulation separate

abstract type TriangulationStyle <: GridapType end

Subtypes:

• JointDomains
• SplitDomains

const TupOfArrayContribution{T} = Tuple{Vararg{ArrayContribution{T}}}

Specifically allows to deal with tuples of Jacobians in unsteady settings

const VectorContribution{T} = ArrayContribution{T,1}

const ∂₁ = PartialDerivative{1}

const ∂₂ = PartialDerivative{2}

const ∂₃ = PartialDerivative{3}

function collect_cell_matrix_for_trian(
  trial::FESpace,
  test::FESpace,
  a::DomainContribution,
  strian::Triangulation
  ) -> Tuple{Vector{<:Any},Vector{<:Any},Vector{<:Any}}

Computes the cell-wise data needed to assemble a global sparse matrix for a given input triangulation strian

function collect_cell_vector_for_trian(
  test::FESpace,
  a::DomainContribution,
  strian::Triangulation
  ) -> Tuple{Vector{<:Any},Vector{<:Any}}

Computes the cell-wise data needed to assemble a global vector for a given input triangulation strian

compute_error(
  sol::AbstractArray{T,N},
  sol_approx::AbstractArray{T,N},
  args...
  ) where {T,N} -> Number

Computes the error between sol and sol_approx, by default in the Euclidean norm. A different norm (usually represented by a sparse matrix) can be provided as an argument.

compute_relative_error(
  sol::AbstractArray{T,N},
  sol_approx::AbstractArray{T,N},
  args...
  ) where {T,N} -> Number

Computes the relative error between sol and sol_approx, by default in the Euclidean norm. A different norm (usually represented by a sparse matrix) can be provided as an argument.

compute_speedup(t1::CostTracker,t2::CostTracker) -> Speedup

Computes the speedup the tracker t2 achieves with respect to t1, in time and in memory footprint

contribution(f,trians) -> Contribution

Constructor of a Contribution that allows do-block syntax. f is a function such that

values[i] = f(trians[i]) for i...

This constructor first builds the tuple of values, then builds the Contribution object from values and trians

get_fe_operator(op::ParamOperator) -> ParamFEOperator

Fetches the underlying FE operator of an algebraic operator op

get_parent(t::Triangulation) -> Triangulation

When t is a triangulation view, returns its parent; throws an error when t is not a triangulation view

get_polynomial_order(f::FESpace) -> Integer

Retrieves the polynomial order of f

get_polynomial_orders(fs::FESpace) -> Integer

Retrieves the polynomial order of fs for every dimension

is_parent(parent::Triangulation,child::Triangulation) -> Bool

Returns true if child is a triangulation view of parent, false otherwise

isapprox_parent(parent::Triangulation,child::Triangulation) -> Bool

Same as is_parent, but with a relaxed check (it could return true even when the objectid comparison fails)

order_domains(
  parents::Tuple{Vararg{Triangulation}},
  children::Tuple{Vararg{Triangulation}}
  ) -> Tuple{Vararg{Triangulation}}

Orders the triangulation children in the same way as the triangulation parents