Merge pull request #681 from CEED/jed/doc-fixes

doc fixes

doc: add missing DOIs

Merge branch 'main' into natalie/hip-ref-v2

Merge branch 'leila/bc' [PR #540]

* leila/bc: (57 commits)
examples/fluids: fix doc
examples/fluids: comments on ICs and BCs & style
NS: style
examples/fluids: CreateRestrictionFromPlex: han

Merge branch 'leila/bc' [PR #540]

* leila/bc: (57 commits)
examples/fluids: fix doc
examples/fluids: comments on ICs and BCs & style
NS: style
examples/fluids: CreateRestrictionFromPlex: handle empty domainIS
examples/fluids: style
examples/fluids/advection.h: spherical bubble is the default IC
examples/fluids: style
examples/fluids/advection.h: fixed in/outflow signs for implicit scheme
examples/fluids: comments
examples/fluids: PetscBool -> bool in QFunctions
examples/fluids: removed periodicity from the setup struct
examples/fluids: clear DS and fields in -viz_refine
examples/fluids/setup-boundary.h: comment
examples/fluids/advection2d.h: removed unused variables
doc/NS: update
examples/fluids/advection.h: spherical bubble is the default IC
examples/fluids: fix sign and simplify advection2d inflow/outflow for implicit/explicit
examples/fluids: u_* = u_R on inflow boundaries
doc: added representative runs for TRANSLATION mode
examples/fluids: Total Energy is now prescribed for inflow BCs and can be changed using -E_wind
...

show more ...

doc/NS: update

update doc

Fluids - fix doc

Fluids - update doc

doc: Fluids - added weak form boundary integrals for in/outflow BCs

doc: Fluids - specified in/outflow surfaces in the boundary in

doc/NS: update

update doc

Fluids - fix doc

Fluids - update doc

doc: Fluids - added weak form boundary integrals for in/outflow BCs

doc: Fluids - specified in/outflow surfaces in the boundary integrals

fix doc

show more ...

examples/fluids: updated command line options, doc, README and, comments

examples/fluids: updated command line options and README

doc updated

examples/fluids: updated README & ~_left -> ~_wi

examples/fluids: updated command line options, doc, README and, comments

examples/fluids: updated command line options and README

doc updated

examples/fluids: updated README & ~_left -> ~_wind & ~_right -> ~ & comments

update doc

examples/fluids/advection(2d).h: update comments

examples/fluids: fix doc

show more ...

Merge pull request #496 from CEED/v0.6changelog

v0.6: Release notes

User manual style: alphabetize refs

Merge branch 'master' into valeria/jupyter-notebook-tutorials

Solid Mechanics Example (#474)

libCEED + PETSc Solid Mechanics example

Co-authored-by: Jeremy L Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Arash Mehraban <arashm81@gmail.com>
Co-au

Solid Mechanics Example (#474)

libCEED + PETSc Solid Mechanics example

Co-authored-by: Jeremy L Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Arash Mehraban <arashm81@gmail.com>
Co-authored-by: Jed Brown <jed@jedbrown.org>
Co-authored-by: Valeria Barra <valeriabarra21@gmail.com>


* Solids - initial commit of elasticity example

Co-authored-by: Jeremy L Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Arash Mehraban <arashm81@gmail.com>

* Solids - add VLA macro

* Solids - fix test for mesh file output string

* Solids - update documentation

Co-authored-by: Jeremy L Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Arash Mehraban <arashm81@gmail.com>

* Solids - update README

* Solids - update ctx struct and casting for CUDA

* Tests - clean up test conditions for GPU backends

* GPU - fix falbacks identified

* CUDA - whitelist FDM Inverse

* make style

* doc: solids editing/correctness

* Solids - separate FE boilerplate into its own function

* Solids - clean up double includes

* doc: add more complete explanation of hyperelasticity and formulation

* Solids - Use ISGetSize for global number of face sets (had no effect on PETSc bug in MR 2615)

* edited docs for hyperFS

* Improve doc of solids example with some constitent notation and fonts

* HyperSS docs modified

* edited typo

* linearization added

* fixed a typo

* Improved doc

* doc: more writing on hyperelasticity and implementation tradeoffs

* Solids - fix typo

* Solids - compute and store C, Cinv, and S as symmetric

* Solids - use new Newton linearization, but its not converging

* Solids - update BC handling

* Solids - update README with new BC options

* removed old notation

* Solids - whitespace changes only in documentation

* doc: adjust differential notation and derive dP(dF)

* Solids - small documentation flow edits

* Solids - simplify setting BCs

* Solids - Symmetritize e in SS

* Solids - set more reasonable default number of steps for nonlinear

* Solids - fix documentation typo

* Solids - clean up computation of deltaS

* Solids - fix sample runs

* Solids - fix hyperSS jacobian

* Solids - fix hyperSS documentation

* Solids - clean up code for hyperSS

* Solids - add file and function docstrings

* doc: commutative diagram of linearization and stable stress expression

* Solids - update hyperSS documentation with linearization

* doc: further tips on stable computation

* Solids - fix typo with trace in hyperSS

* Solids - intro and hyperSS documentation updates

* Solids - update hyperFS for numerical stability with small E and nearly incompressible

* examples/solids: simpler C = I + 2E

* Solids - more compact/readable E computation

* Solids - minor style consistency change

* Solids - replace log1p with series approximation, log1p is not vectorized in libc

* Solids - refactor common components between hyperFSF and hyperFSdF

* examples/solids: use PETSc dependency flags for incremental rebuild

* examples/solids: extend range of log1p_series via shift/scale

* Solids - add bc_clamp_max option to specify maximum displacement for clamped boundary

* make style

* Solids - update with sample run informantion and spellchecking

* Doc - typo fixes

* Solids - homogonize presentation of command line options

* examples/solids: fix -Wmisleading-indentation

* examples/fluids: PETSc 3.13 compatibility

* examples/solids: use log1p for numerical stability in hyperSS

* doc: copy editing in examples/solids

* Solids - update documentation on running the code

* Solids - convert README to rst and include in documentation

* Solids - clean dependency file

* Solids - use log1p approximation in hyperSS as well

* Solids - update README to explain mms

* Solids - switch range on hyperSS log1p series approximation

* Solids - update README to clarify mandatory options

* Solids - add link to sample meshes

* Solids - simplify listing of mesh options

* Travis - use newer PETSc

* Solids - update sample run to list [.exo file] instead of name of sample mesh

* Solids - update make clean to remove src/*.d

* examples/solids: makefile cleanup

* make style

* doc examples/solids: clean up and explain nondimensionalization

* examples/solids: document algebraic solver

* examples/solids: use CG for Chebyshev eig estimation

* doc: fix references to examples/fluids

* Solids - remove mesh folder

* Solids - drop expicit ExodusII requirement, PETSc supports many types of meshes

* doc: mention PETSc --download-exodusii for Exodus

* doc: fix latexpdf

* Fix \longrightarrow rendering in PDF

* Solids - fix toctree link to README for pdflatex

* Examples and BPs Docs: Homogenize math with dS and dV and other tiny esthetics

* Solids - fix unshifted series for hyperSS log1p

* Improve doc of bpssphere: Add differential for consistency with all other examples and explain domain for clarity

* Solids - include sample mesh image

* Move mesh figure after note and slightly rename inclusion marker

Co-authored-by: Arash Mehraban <arashm81@gmail.com>
Co-authored-by: Jed Brown <jed@jedbrown.org>
Co-authored-by: valeriabarra <valeriabarra21@gmail.com>

show more ...

Merge pull request #482 from CEED/leila/doc_NS

Leila/doc ns

NS: stabilization added to doc

Thanks-to: Valeria Barra <valeriabarra21@gmail.com>

Merge pull request #469 from CEED/jed/doc-examples

Jed/doc examples

Add citation and bib info

doc: split examples into separate files in the source tree

* Copy examples/**.rst into the source directory so they can be picked
up by Sphinx.
* Some minor corrections/clarifications to docs that

doc: split examples into separate files in the source tree

* Copy examples/**.rst into the source directory so they can be picked
up by Sphinx.
* Some minor corrections/clarifications to docs that I noticed while
splitting them apart (shame on me for bundling in this commit).

show more ...

Merge pull request #446 from CEED/user-manual

Sphinx user manual published at libceed.readthedocs.io

doc: convert to Sphinx documentation at libceed.readthedocs.io

Some technical notes about the expanded docs/process:

* Doxygen is now restricted to API documentation. Sphinx docs are
incomplete

doc: convert to Sphinx documentation at libceed.readthedocs.io

Some technical notes about the expanded docs/process:

* Doxygen is now restricted to API documentation. Sphinx docs are
incomplete surrogates due to not hyperlinking code listings, though
we hope the Doxygen site can be removed eventually.

* PDF output uses XeTeX (unicode and OTF fonts) with TeX Gyre Pagella
and DejaVu Sans Mono. You may need to install these fonts in order
to build the PDF users manual.

* Obtaining the author list from Git has not worked on
ReadTheDocs (`git shortlog` is empty even though `git log` is not),
so we automatically generate it on developer machines with `make
doc`. If the author information is incorrect/mangled, edit .mailmap
to fix the mapping.

* Math semantics are based on the description here
https://github.com/sphinx-doc/sphinx/issues/3785

Sphinx chooses one of two setups for the maths.

* If there is a single equation, then we wrap the maths in
\begin{equation*} (or equation).

* If there are multiple equations (as determined by the presence of
an empty line), then we wrap the maths first in \begin{aligned}
and then in \begin{align*} (or align).

Co-authored-by: Jeremy L. Thompson <jeremy.thompson@colorado.edu>
Co-authored-by: Jed Brown <jed@jedbrown.org>

show more ...