-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- try `Documenter.jl` native document generation - add custom `make.jl` and `deploy.jl` to override default process - add `index.md` and `api.md` for startings
- Loading branch information
Showing
6 changed files
with
92 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# This file is a part of JuliaFEM. | ||
# License is MIT: see https://github.com/JuliaFEM/Mortar2D.jl/blob/master/LICENSE | ||
|
||
using Documenter | ||
|
||
deploydocs( | ||
repo = "github.com/JuliaFEM/Mortar2D.jl.git", | ||
julia = "0.6", | ||
target = "build", | ||
deps = nothing, | ||
make = nothing) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# This file is a part of JuliaFEM. | ||
# License is MIT: see https://github.com/JuliaFEM/Mortar2D.jl/blob/master/LICENSE | ||
|
||
using Documenter, Mortar2D | ||
|
||
makedocs(modules=[Mortar2D], | ||
format = :html, | ||
sitename = "Mortar2D", | ||
pages = [ | ||
"Introduction" => "index.md", | ||
"API" => "api.md", | ||
]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# API documentation | ||
|
||
```@meta | ||
DocTestSetup = quote | ||
using Mortar2D | ||
using Mortar2D: calculate_normals, project_from_master_to_slave, project_from_slave_to_master, calculate_segments, calculate_mortar_matrices, calculate_mortar_assembly | ||
end | ||
``` | ||
|
||
```@docs | ||
Mortar2D.calculate_normals | ||
Mortar2D.project_from_master_to_slave | ||
Mortar2D.project_from_slave_to_master | ||
Mortar2D.calculate_segments | ||
Mortar2D.calculate_mortar_matrices | ||
Mortar2D.calculate_mortar_assembly | ||
``` | ||
|
||
## Index | ||
|
||
```@index | ||
``` | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,41 @@ | ||
# Mortar2D.jl documentation | ||
|
||
![Typical 2d segmentation](figs/contact_segmentation.png) | ||
```@contents | ||
Pages = ["index.md", "api.md"] | ||
``` | ||
|
||
```@meta | ||
DocTestSetup = quote | ||
using Mortar2D | ||
end | ||
``` | ||
Mortar2D.jl is a julia package to calculate discrete projections between | ||
non-conforming finite element mesheds. The resulting "mortar matrices" can | ||
be used to tie non-conforming finite element meshes together which are meshed | ||
separately to construct bigger models. | ||
|
||
## Constants | ||
Using mortar methods in mesh tie problems results variationally consistent | ||
solution. Mathematically, goal is to solve mixed problem with primary field | ||
variable and Lagrange multipliers, which have a physical meaning (e.g. contact | ||
pressure if unknown field is displacement). The problem arising is a typical | ||
saddle point problem with zeros on diagonal. | ||
|
||
```@docs | ||
``` | ||
Mortar2D.jl is part of JuliaFEM. All codes are MIT licensed. | ||
|
||
## Functions | ||
|
||
```@docs | ||
``` | ||
## Installing and testing package | ||
|
||
## Index | ||
Installing package goes same way like other packages in julia, i.e. | ||
```julia | ||
julia> Pkg.add("Mortar2D") | ||
``` | ||
|
||
```@index | ||
Testing package can be done using `Pkg.test`, i.e. | ||
```julia | ||
julia> Pkg.test("Mortar2D") | ||
``` | ||
|
||
## Contributing | ||
|
||
Have a new great idea and want to share it with the open source community? | ||
From [here](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md) | ||
and [here](https://juliadocs.github.io/Documenter.jl/stable/man/contributing/) | ||
you can look for coding style. [Here](https://docs.julialang.org/en/stable/manual/packages/#Making-changes-to-an-existing-package-1) is explained how to contribute to | ||
open source project, in general. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters