Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JordiManyer committed Dec 10, 2024
1 parent b0329b6 commit d3b7159
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 130 deletions.
167 changes: 41 additions & 126 deletions docs/src/ReferenceFEs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,162 +4,77 @@ CurrentModule = Gridap.ReferenceFEs

# Gridap.ReferenceFEs

## Polytopes

```@docs
Polytope
Base.==
test_polytope
```@contents
Pages = ["ReferenceFEs.md"]
Depth = 2:3
```

### Polytope Geometry
## Polytopes

```@docs
get_edge_tangent
get_facet_normal
get_facet_orientations
get_vertex_coordinates
get_face_coordinates
get_bounding_box
```
### Abstract API

### Polytope Topology

```@docs
num_dims
num_faces
num_facets
num_edges
num_vertices
get_faces
get_dimranges
get_dimrange
get_facedims
get_reffaces
get_face_dimranges
get_face_type
get_face_vertices
get_face_vertex_permutations
get_vertex_permutations
get_offsets
get_offset
is_n_cube
is_simplex
simplexify
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["/Polytopes.jl"]
```

### Extrusion Polytopes

```@docs
ExtrusionPolytope
get_extrusion
HEX_AXIS
TET_AXIS
VERTEX
SEGMENT
TRI
QUAD
TET
HEX
WEDGE
PYRAMID
next_corner!
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["ExtrusionPolytopes.jl"]
```

### General Polytopes

```@docs
GeneralPolytope
Polygon
Polyhedron
get_graph
get_metadata
isopen
isactive
check_polytope_graph
simplexify_interior
simplexify_surface
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["GeneralPolytopes.jl"]
```

## Quadratures

```@docs
Quadrature
get_coordinates
get_weights
get_name
num_points
num_point_dims
num_dims
test_quadratures
GenericQuadrature
### Abstract API

```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["/Quadratures.jl"]
```

### Available Quadratures

```@docs
TensorProduct
Duffy
Strang
XiaoGimbutas
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["TensorProductQuadratures.jl","DuffyQuadratures.jl","StrangeQuadratures.jl","XiaoGimbutasQuadratures.jl"]
```

## ReferenceFEs

```@docs
ReferenceFE
ReferenceFEName
GenericReferenceFE
num_dims
num_cell_dims
num_point_dims
num_faces
num_vertices
num_edges
num_facets
num_dofs
get_polytope
get_prebasis
get_shapefuns
get_dof_basis
compute_shapefuns
compute_dofs
Conformity
get_face_dofs
get_face_own_dofs
get_face_own_dofs_permutations
test_reference_fe
### Abstract API

```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["ReferenceFEInterfaces.jl","Dofs.jl"]
```

### Nodal ReferenceFEs

```@docs
LagrangianRefFE
is_first_order
is_P
is_Q
is_S
compute_monomial_basis
compute_own_nodes
compute_face_orders
compute_nodes
compute_own_nodes_permutations
compute_lagrangian_reffaces
VERTEX1
SEG2
QUAD4
TRI3
TET4
HEX8
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["LagrangianRefFEs.jl","LagrangianDofBases.jl","SerendipityRefFEs.jl","BezierRefFEs.jl","ModalC0RefFEs.jl"]
```

### Moment-Based ReferenceFEs

```@docs
MomentBasedReferenceFE
RaviartThomasRefFE
NedelecRefFE
BDMRefFE
ArnoldWintherRefFE
MardalTaiWintherRefFE
```@autodocs
Modules = [ReferenceFEs,]
Order = [:type, :constant, :macro, :function]
Pages = ["MomentBasedReferenceFEs.jl","RaviartThomasRefFEs.jl","NedelecRefFEs.jl","BDMRefFEs.jl","CRRefFEs.jl"]
```
8 changes: 4 additions & 4 deletions src/ReferenceFEs/LagrangianRefFEs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,10 @@ end

# Generic implementation
"""
struct GenericLagrangianRefFE{C,D} <: LagrangianRefFE{D}
reffe::GenericRefFE{C,D}
face_nodes::Vector{Vector{Int}}
end
struct GenericLagrangianRefFE{C,D} <: LagrangianRefFE{D}
reffe::GenericRefFE{C,D}
face_nodes::Vector{Vector{Int}}
end
"""
struct GenericLagrangianRefFE{C,D} <: LagrangianRefFE{D}
reffe::GenericRefFE{C,D}
Expand Down

0 comments on commit d3b7159

Please sign in to comment.