Adapt signatures and add docs

Author: pjaap

src/common_restrictions/coupled_dofs_restriction.jl

@@ -3,12 +3,24 @@ struct CoupledDofsRestriction{TM} <: AbstractRestriction
     parameters::Dict{Symbol, Any}
 end
 
+
+"""
+    CoupledDofsRestriction(matrix::AbstractMatrix)
+
+    Creates an restriction that couples dofs together.
+
+    The coupling is stored in a CSC Matrix `matrix`, s.t.,
+
+    dofᵢ = Σⱼ Aⱼᵢ dofⱼ (col-wise)
+
+    The matrix can be obtained from, e.g., `get_periodic_coupling_matrix`.
+"""
 function CoupledDofsRestriction(matrix::AbstractMatrix)
     return CoupledDofsRestriction(matrix, Dict{Symbol, Any}(:name => "CoupledDofsRestriction"))
 end
 
 
-function assemble!(R::CoupledDofsRestriction, A, b, sol, SC; kwargs...)
+function assemble!(R::CoupledDofsRestriction, SC; kwargs...)
 
     # extract all col indices
     _, J, _ = findnz(R.coupling_matrix)

src/problemdescription.jl

@@ -96,7 +96,18 @@ function assign_operator!(PD::ProblemDescription, o::AbstractOperator)
     return length(PD.operators)
 end
 
+"""
+$(TYPEDSIGNATURES)
+
+Adds a restrction to a `ProblemDescription`.
+
+# Arguments
+- `PD::ProblemDescription`: The problem description to which the operator should be added.
+- `r::AbstractRestriction`: The restriction to add.
 
+# Returns
+- The index (position) of the restriction in the `restrictions` array of `PD`.
+"""
 function assign_restriction!(PD::ProblemDescription, r::AbstractRestriction)
     push!(PD.restrictions, r)
     return length(PD.restrictions)

src/restrictions.jl

@@ -16,7 +16,7 @@ function is_timedependent(R::AbstractRestriction)
     return false
 end
 
-function assemble!(R::AbstractRestriction, A, b, sol, SC; kwargs...)
+function assemble!(R::AbstractRestriction, SC; kwargs...)
     ## assembles internal restriction matrix in R
     return nothing
 end

src/solvers.jl

@@ -227,7 +227,7 @@ function solve_linear_system!(A, b, sol, soltemp, residual, linsolve, unknowns,
         ## assemble restrctions
         if !SC.parameters[:initialized]
             for restriction in PD.restrictions
-                @timeit timer "$(restriction.parameters[:name])" assemble!(restriction, A, b, sol, SC; kwargs...)
+                @timeit timer "$(restriction.parameters[:name])" assemble!(restriction, SC; kwargs...)
             end
         end
     end