Skip to content

Commit 96c289e

Browse files
committed
Update README.md and add FILTER_PATTERN for Doxygen
- Allows single README.md to be reused for MathJax markup on Github and with Doxygen
1 parent cf604a3 commit 96c289e

File tree

2 files changed

+4
-17
lines changed

2 files changed

+4
-17
lines changed

README.md

+1-14
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,6 @@ The Compadre Toolkit provides a performance portable solution for the parallel e
77
This toolkit focuses on the 'on-node' aspects of meshless PDE solution and remap, namely the parallel construction of small dense matrices and their inversion. What it does **not** provide is the tools for managing fields, inverting globally sparse matrices, or neighbor search that requires orchestration over many MPI processes. This toolkit is designed to be easily dropped-in to an existing MPI (or serial) based framework for PDE solution or remap, with minimal dependencies ([Kokkos](https://github.com/kokkos/kokkos) and [KokkosKernels](https://github.com/kokkos/kokkos-kernels)).
88

99
### Generalized Moving Least Squares (GMLS)
10-
<!---
11-
A GMLS problem requires the specification of a target functional ![equation](https://latex.codecogs.com/gif.latex?\tau) (Compadre::TargetOperation), a reconstruction space ![equation](https://latex.codecogs.com/gif.latex?V) (Compadre::ReconstructionSpace), and a sampling functional ![equation](https://latex.codecogs.com/gif.latex?\lambda) (Compadre::SamplingFunctional).
12-
13-
The Compadre Toolkit is designed to efficiently assemble, factorize, and solve large batches of minimization problems having the form:
14-
15-
![equation](https://latex.codecogs.com/png.latex?%5Cbg_white%20%5Clarge%20%5C%5C%20%5Cbegin%7Balign*%7D%20p%5E%7B*%7D%26%20%3D%26%20%5Cunderset%7Bp%20%5Cin%20V%7D%7B%5Ctext%7Barg%20min%7D%7D%5C%3B%5Cfrac%7B1%7D%7B2%7D%5Csum_%7Bj%3D1%7D%5EN%20%28%5Clambda_j%28u%29-%5Clambda_j%28p%29%29%5E%7B2%7D%5Comega%28%5Ctau%3B%5Clambda_j%29%5C%5C%5C%5C%20%26%26%5Ctau%28u%29%20%5Capprox%20%5Ctau%28p%5E%7B*%7D%29%20%5Cend%7Balign*%7D)
16-
17-
https://www.codecogs.com/latex/eqneditor.php
18-
\[\large \begin{align*}
19-
p^{*}& =& \underset{p \in V}{\text{arg min}}\;\frac{1}{2}\sum_{j=1}^N (\lambda_j(u)-\lambda_j(p))^{2}\omega(\tau;\lambda_j)\\\\
20-
&&\tau(u) \approx \tau(p^{*})
21-
\end{align*} \]
22-
--->
2310

2411
Here is a brief overview of the GMLS framework:
2512

@@ -34,7 +21,7 @@ With an optimal reconstruction $p$ in hand, the target functional is approximate
3421
As an unconstrained $\ell_2$-optimization problem, this process admits the explicit form:
3522

3623

37-
$$\tau^h_{\tilde{x}}(\phi) = \tau_{\tilde{x}}(\mathbf{P})^\intercal \left(\Lambda(\mathbf{P})^\intercal \mathbf{W} \Lambda(\mathbf{P})\right)^{-1} \Lambda(\mathbf{P})^\intercal \mathbf{W} \Lambda(\phi),$$
24+
$$\tau^h_{\tilde{x}}(\phi) = \tau_{\tilde{x}}(\mathbf{P})^\top \left(\Lambda(\mathbf{P})^\top \mathbf{W} \Lambda(\mathbf{P})\right)^{-1} \Lambda(\mathbf{P})^\top \mathbf{W} \Lambda(\phi),$$
3825

3926
where:
4027
* $\tau_{\tilde{x}}(\mathbf{P}) \in \mathbb{R}^{dim(V_h)}$ is a vector with components consisting of the target functional applied to each basis function,

doc/Doxyfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ INPUT_FILTER =
926926
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
927927
# patterns match the file name, INPUT_FILTER is applied.
928928

929-
FILTER_PATTERNS =
929+
FILTER_PATTERNS += "*.md=sed 's/\([^$]\)\$\([^$]*\)\$\([^$]\)/\1\\f$\2\\f$\3/g;s/\\{/\{/g;s/\\}/\}/g'"
930930

931931
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
932932
# INPUT_FILTER ) will also be used to filter the input files that are used for
@@ -1500,7 +1500,7 @@ FORMULA_TRANSPARENT = YES
15001500
# The default value is: NO.
15011501
# This tag requires that the tag GENERATE_HTML is set to YES.
15021502

1503-
USE_MATHJAX = NO
1503+
USE_MATHJAX = YES
15041504

15051505
# When MathJax is enabled you can set the default output format to be used for
15061506
# the MathJax output. See the MathJax site (see:
@@ -1633,7 +1633,7 @@ EXTRA_SEARCH_MAPPINGS =
16331633
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
16341634
# The default value is: YES.
16351635

1636-
GENERATE_LATEX = YES
1636+
GENERATE_LATEX = NO
16371637

16381638
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
16391639
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

0 commit comments

Comments
 (0)