Skip to content

Commit

Permalink
spelling typos
Browse files Browse the repository at this point in the history
  • Loading branch information
gtheler committed Jul 17, 2024
1 parent 04497c8 commit 8c2e75b
Show file tree
Hide file tree
Showing 25 changed files with 76 additions and 71 deletions.
4 changes: 2 additions & 2 deletions README4engineers
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ There are two “why” questions we have to answer.
- material properties can be given as functions of space
and/or time and/or temperature (or other intermediate
variables)
- these functions can be given as algebraic expresions or
come from interpolateed point-wise defined data
- these functions can be given as algebraic expressions or
come from interpolated point-wise defined data
- 100% user-defined output
- simple problems need simple inputs
- similar problems need similar inputs
Expand Down
4 changes: 2 additions & 2 deletions README4engineers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@ There are two “why” questions we have to answer.
- everything is an expression
- material properties can be given as functions of space and/or
time and/or temperature (or other intermediate variables)
- these functions can be given as algebraic expresions or come
from interpolateed point-wise defined data
- these functions can be given as algebraic expressions or come
from interpolated point-wise defined data
- [100% user-defined output]
- simple problems need simple inputs
- similar problems need similar inputs
Expand Down
2 changes: 1 addition & 1 deletion README4engineers.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ There are two "why" questions we have to answer.
- Git-traceable (mesh is not part of the input file)
- everything is an expression
- material properties can be given as functions of space and/or time and/or temperature (or other intermediate variables)
- these functions can be given as algebraic expresions or come from interpolateed point-wise defined data
- these functions can be given as algebraic expressions or come from interpolated point-wise defined data
* [100% user-defined output](https://seamplex.com/feenox/doc/sds.html#sec:output)
* simple problems need simple inputs
* similar problems need similar inputs
Expand Down
6 changes: 3 additions & 3 deletions dist/control
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Section: science
Priority: optional
Maintainer: Jeremy Theler <[email protected]>
Build-Depends: debhelper-compat (= 13),
libgsl-dev,
libgsl-dev,
libsundials-dev,
petsc-dev,
slepc-dev
Standards-Version: 4.5.1
Standards-Version: 4.6.2
Homepage: https://www.seamplex.com/feenox
Rules-Requires-Root: no
Vcs-Git: https://github.com/seamplex/feenox.git
Expand All @@ -25,7 +25,7 @@ Description: cloud-first free no-X uniX-like finite-element(ish) tool
near-English self descriptive input file read at run time,
without requiring further user intervention after the invocation.
.
So far it can solve
So far it can solve
.
* Basic mathematics
* Systems of ODEs/DAEs
Expand Down
9 changes: 7 additions & 2 deletions dist/dsc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ fi

rm -rf feenox-${version}
tar -xvzf feenox-${version}.tar.gz

cd feenox-${version}
debmake
cp ../README.Debian ../control ../copyright ../rules debian/
cp ../README.Debian ../control ../copyright ../rules ../watch debian/
cp ../metadata debian/upstream
m4 -Dfeenox_version=${version} ../changelog > debian/changelog
rm debian/watch debian/source/control debian/tests/control debian/patches/series debian/source/local-options debian/source/options debian/source/patch-header
rm debian/source/control debian/tests/control debian/patches/series debian/source/local-options debian/source/options debian/source/patch-header
rmdir debian/patches
rm COPYING
debuild

cd ..
lintian -v -i -I -E --pedantic --profile debian feenox_${version}-1.dsc
13 changes: 6 additions & 7 deletions dist/metadata
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
#
# DEP-12: Per-package machine-readable metadata about Upstream
# Please check * https://dep-team.pages.debian.net/deps/dep12/
# * https://wiki.debian.org/UpstreamMetadata
Bug-Database: https://github.com/seamplex/feenox/issues
Bug-Submit: https://github.com/seamplex/feenox/issues/new
Repository: https://github.com/seamplex/feenox.git
Repository-Browse: https://github.com/seamplex/feenox
Reference:
Author: Jeremy Theler
Title: FeenoX: a cloud-first finite-element(ish) computational engineering tool
Journal: Journal of Open Source Software,
Title: FeenoX, a cloud-first finite-element(ish) computational engineering tool
Journal: Journal of Open Source Software
Year: 2024
Volume: 9
Number: 95
Pages: 5846
DOI: 10.21105/joss.05846
URL: https://doi.org/10.21105/joss.05846

2 changes: 2 additions & 0 deletions dist/watch
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
version=4
https://seamplex.com/feenox/dist/src/feenox-(.+).tar.gz
2 changes: 1 addition & 1 deletion doc/CODE_OF_CONDUCT.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ chaptersDepth: 1
codeBlockCaptions: false
cref: false
crossrefYaml: pandoc-crossref.yaml
date: 2024-06-14
date: 2024-07-17
eqLabels: arabic
eqnBlockInlineMath: false
eqnBlockTemplate: |
Expand Down
2 changes: 1 addition & 1 deletion doc/FAQ.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ chaptersDepth: 1
codeBlockCaptions: false
cref: false
crossrefYaml: pandoc-crossref.yaml
date: 2024-06-14
date: 2024-07-17
eqLabels: arabic
eqnBlockInlineMath: false
eqnBlockTemplate: |
Expand Down
4 changes: 2 additions & 2 deletions doc/README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ reference.
- [History][] [PDF][8]

[Unix manpage]: https://www.seamplex.com/feenox/doc/feenox.1.html
[Frequently Asked Questions]: FAQs.markdown
[PDF]: https://www.seamplex.com/feenox/doc/FAQs.pdf
[Frequently Asked Questions]: FAQ.markdown
[PDF]: https://www.seamplex.com/feenox/doc/FAQ.pdf
[Compilation Guide]: compilation.markdown
[6]: https://www.seamplex.com/feenox/doc/compilation.pdf
[Programming Guide]: programming.markdown
Expand Down
33 changes: 16 additions & 17 deletions doc/feenox.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.2
.\"
.TH "FEENOX" "1" "2024\-06\-14" "FeenoX" "FeenoX User Manual"
.TH "FEENOX" "1" "2024\-07\-15" "FeenoX" "FeenoX User Manual"
.SH NAME
FeenoX \- a cloud\-first free no\-X uniX\-like finite\-element(ish)
computational engineering tool
Expand Down Expand Up @@ -115,7 +115,7 @@ feenox [options] inputfile [replacement arguments] [petsc options]
.EE
.TP
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
display options and detailed explanations of commmand\-line usage
display options and detailed explanations of command\-line usage
.TP
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
display brief version information and exit
Expand Down Expand Up @@ -281,9 +281,8 @@ If not explicitly given, the nature of the file will be taken from
context, i.e.\ \f[CR]FILE\f[R]s in \f[CR]PRINT\f[R] will be
\f[CR]OUTPUT\f[R] and \f[CR]FILE\f[R]s in \f[CR]FUNCTION\f[R] will be
\f[CR]INPUT\f[R].
This keyword justs defines the \f[CR]FILE\f[R], it does not open it.
The file will be actually openened (and eventually closed)
automatically.
This keyword just defines the \f[CR]FILE\f[R], it does not open it.
The file will be actually opened (and eventually closed) automatically.
In the rare case where the automated opening and closing does not fit
the expected workflow, the file can be explicitly opened or closed with
the instructions \f[CR]FILE_OPEN\f[R] and \f[CR]FILE_CLOSE\f[R].
Expand Down Expand Up @@ -354,9 +353,9 @@ FUNCTION <function_name>(<var_1>[,var2,...,var_n]) {
The number of variables \f[I]n\f[R] is given by the number of arguments
given between parenthesis after the function name.
The arguments are defined as new variables if they had not been already
defined explictly as scalar variables.
defined explicitly as scalar variables.
If the function is given as an algebraic expression, the short\-hand
operator \f[CR]=\f[R] (or \f[CR]:=\f[R] for compatiblity with Maxima)
operator \f[CR]=\f[R] (or \f[CR]:=\f[R] for compatibility with Maxima)
can be used.
That is to say, \f[CR]FUNCTION f(x) = x\[ha]2\f[R] is equivalent to
\f[CR]f(x) = x\[ha]2\f[R] (or \f[CR]f(x) := x\[ha]2\f[R]).
Expand Down Expand Up @@ -386,7 +385,7 @@ of nodes.
The function can be pointwise\-defined inline in the input using
\f[CR]DATA\f[R].
This should be the last keyword of the line, followed by
\f[I]N\f[R] = \f[I]k\f[R] ⋅ (\f[I]n\f[R] + 1) expresions
\f[I]N\f[R] = \f[I]k\f[R] ⋅ (\f[I]n\f[R] + 1) expressions
giving\ \f[I]k\f[R] definition points: \f[I]n\f[R] arguments and the
value of the function.
Multiline continuation using brackets \f[CR]{\f[R] and \f[CR]}\f[R] can
Expand Down Expand Up @@ -738,7 +737,7 @@ When implicit definition is allowed (see \f[CR]IMPLICIT\f[R]), scalar
variables need not to be defined before being used if from the context
FeenoX can tell that an scalar variable is needed.
For instance, when defining a function like \f[CR]f(x) = x\[ha]2\f[R] it
is not needed to declare \f[CR]x\f[R] explictly as a scalar variable.
is not needed to declare \f[CR]x\f[R] explicitly as a scalar variable.
But if one wants to define a function like
\f[CR]g(x) = integral(f(x\[aq]), x\[aq], 0, x)\f[R] then the variable
\f[CR]x\[aq]\f[R] needs to be explicitly defined as
Expand Down Expand Up @@ -819,7 +818,7 @@ The time step \f[CR]dt\f[R] will be reduced whenever the distance
between the current time \f[CR]t\f[R] and the next expression in the
list is greater than \f[CR]dt\f[R] so as to force \f[CR]t\f[R] to
coincide with the expressions given.
The list of expresssions should evaluate to a sorted list of values for
The list of expressions should evaluate to a sorted list of values for
all times.
.SS PDE\-RELATED KEYWORDS
.SS \f[CR]BC\f[R]
Expand Down Expand Up @@ -974,10 +973,10 @@ ratio\ \f[CR]nu\f[R].
Modal also needs density\ \f[CR]rho\f[R].
Check the particular documentation for each problem type.
Besides these mandatory properties, any other one can be defined.
For instance, if one mandatory property dependend on the concentration
of boron in the material, a new per\-material property can be added
named \f[CR]boron\f[R] and then the function \f[CR]boron(x,y,z)\f[R] can
be used in the expression that defines the mandatory property.
For instance, if one mandatory property depended on the concentration of
boron in the material, a new per\-material property can be added named
\f[CR]boron\f[R] and then the function \f[CR]boron(x,y,z)\f[R] can be
used in the expression that defines the mandatory property.
.SS \f[CR]PETSC_OPTIONS\f[R]
.PP
Pass verbatim options to PETSc.
Expand Down Expand Up @@ -1040,7 +1039,7 @@ file with different names.
.PP
Likewise, for non\-volumetric elements, physical groups can be linked to
boundary using \f[CR]BC\f[R].
As in the preceeding case, if a boundary condition is created with the
As in the preceding case, if a boundary condition is created with the
same name as a physical group in the mesh, they will be linked
automatically, so there is no need to use \f[CR]PHYSCAL_GROUP\f[R] for
this.
Expand Down Expand Up @@ -1138,7 +1137,7 @@ If \f[CR]end_time\f[R] is non\-zero, FeenoX solves a transient or
quasi\-static problem.
This can be controlled by \f[CR]TRANSIENT\f[R] or
\f[CR]QUASISTATIC\f[R].
By default FeenoX tries to detect wheter the computation should be
By default FeenoX tries to detect whether the computation should be
linear or non\-linear.
An explicit mode can be set with either \f[CR]LINEAR\f[R] on
\f[CR]NON_LINEAR\f[R].
Expand Down Expand Up @@ -1486,7 +1485,7 @@ Not\-A\-Number signal (such as a division by zero) is generated when
evaluating any expression within feenox.
.SS \f[CR]pi\f[R]
.PP
A double\-precision floating point representaion of the number
A double\-precision floating point representation of the number
\f[I]π\f[R]
.PP
It is equal to the \f[CR]M_PI\f[R] constant in \f[CR]math.h\f[R] .
Expand Down
2 changes: 1 addition & 1 deletion doc/help-options-base.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-h, --help display options and detailed explanations of commmand-line usage
-h, --help display options and detailed explanations of command-line usage
-v, --version display brief version information and exit
-V, --versions display detailed version information
-c, --check validates if the input file is sane or not
Expand Down
2 changes: 1 addition & 1 deletion doc/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ feenox [options] inputfile [replacement arguments] [petsc options]

`-h`, `--help`

: display options and detailed explanations of commmand-line usage
: display options and detailed explanations of command-line usage


`-v`, `--version`
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorials/210-input-expressions-args.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ $ wasora hello.was
hello world!
$

The keyword TEXT is not strictly needed (unless given the IMPLICIT NONE keyword), as the construction hello world! does not resolve to any known symbol. However, it is a good practice to explictly precede any text with the TEXT keyword.
The keyword TEXT is not strictly needed (unless given the IMPLICIT NONE keyword), as the construction hello world! does not resolve to any known symbol. However, it is a good practice to explicitly precede any text with the TEXT keyword.

# The Peano axiom

Expand Down Expand Up @@ -88,7 +88,7 @@ When PRINT finds a new argument, it tries to evaluate it. If it does not make an

```
# actually arguments of the PRINT keyword may be either text
# strings, scalar expresions, vectors or matrices (more about
# strings, scalar expressions, vectors or matrices (more about
# these latter two issues in more complex examples)
# the example of Kernigham & Ritchie HOC code
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/220-static-transient.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Output of lag.was

Instead of writing the long input shown in lag.was, we could have obtained the same result with a couple of lines. Indeed, the terminal shows that the output of this input is the same as the one of the previous longer example.

# the preceeding example could have been written in fewer
# the preceding example could have been written in fewer
# lines as follows (although the SPOT rule is broken)
end_time = 5
dt = 1/20
Expand Down
10 changes: 5 additions & 5 deletions src/flow/define.c
Original file line number Diff line number Diff line change
Expand Up @@ -219,11 +219,11 @@ int feenox_vector_attach_function(const char *name, const char *function_data) {
vector_t *vector;
function_t *function;
if ((vector = feenox_get_vector_ptr(name)) == NULL) {
feenox_push_error_message("unkown vector '%s'", name);
feenox_push_error_message("unknown vector '%s'", name);
return FEENOX_ERROR;
}
if ((function = feenox_get_function_ptr(function_data)) == NULL) {
feenox_push_error_message("unkown function '%s'", function_data);
feenox_push_error_message("unknown function '%s'", function_data);
return FEENOX_ERROR;
}
Expand All @@ -236,7 +236,7 @@ int feenox_vector_attach_data(const char *name, expr_t *datas) {

vector_t *vector;
if ((vector = feenox_get_vector_ptr(name)) == NULL) {
feenox_push_error_message("unkown vector '%s'", name);
feenox_push_error_message("unknown vector '%s'", name);
return FEENOX_ERROR;
}

Expand Down Expand Up @@ -267,7 +267,7 @@ int feenox_matrix_attach_data(const char *name, expr_t *datas) {

matrix_t *matrix;
if ((matrix = feenox_get_matrix_ptr(name)) == NULL) {
feenox_push_error_message("unkown matrix '%s'", name);
feenox_push_error_message("unknown matrix '%s'", name);
return FEENOX_ERROR;
}

Expand Down Expand Up @@ -320,7 +320,7 @@ int feenox_file_set_path_argument(const char *name, int i, const char *expressio

file_t *file = NULL;
if ((file = feenox_get_file_ptr(name)) == NULL) {
feenox_push_error_message("unkown file '%s'", name);
feenox_push_error_message("unknown file '%s'", name);
return FEENOX_ERROR;
}

Expand Down
4 changes: 2 additions & 2 deletions src/flow/init.c
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ int feenox_initialize(int argc, char **argv) {
///help+usage+desc [options] inputfile [replacement arguments] [petsc options]
const struct option longopts[] = {
///op+help+option `-h`, `--help`
///op+help+desc display options and detailed explanations of commmand-line usage
///op+help+desc display options and detailed explanations of command-line usage
{ "help", no_argument, NULL, 'h'},
///op+version+option `-v`, `--version`
///op+version+desc display brief version information and exit
Expand Down Expand Up @@ -348,7 +348,7 @@ int feenox_init_special_objects(void) {
///va+j+desc Dummy index, used mainly in matrix column subindex expressions.
feenox_special_var(j) = feenox_get_or_define_variable_get_ptr("j");

///va+pi+desc A double-precision floating point representaion of the number $\pi$
///va+pi+desc A double-precision floating point representation of the number $\pi$
///va+pi+detail It is equal to the `M_PI` constant in `math.h` .
feenox_special_var(pi) = feenox_get_or_define_variable_get_ptr("pi");
feenox_special_var_value(pi) = M_PI;
Expand Down
2 changes: 1 addition & 1 deletion src/math/fit.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ int feenox_instruction_fit(void *arg) {
fit->n_data = fit->data->data_size;
}
if (fit->n_data < fit->n_via) {
feenox_push_error_message("less data points than free paramters for the fit");
feenox_push_error_message("less data points than free parameters for the fit");
return FEENOX_ERROR;
}

Expand Down
8 changes: 4 additions & 4 deletions src/math/function.c
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ int feenox_function_set_argument_variable(const char *name, unsigned int i, cons

function_t *function;
if ((function = feenox_get_function_ptr(name)) == NULL) {
feenox_push_error_message("unkown function '%s'", name);
feenox_push_error_message("unknown function '%s'", name);
return FEENOX_ERROR;
}

Expand Down Expand Up @@ -78,7 +78,7 @@ int feenox_function_set_expression(const char *name, const char *expression) {

function_t *function = NULL;
if ((function = feenox_get_function_ptr(name)) == NULL) {
feenox_push_error_message("unkown function '%s'", name);
feenox_push_error_message("unknown function '%s'", name);
return FEENOX_ERROR;
}

Expand All @@ -92,7 +92,7 @@ int feenox_function_set_file(const char *name, file_t *file, unsigned int *colum

function_t *function = NULL;
if ((function = feenox_get_function_ptr(name)) == NULL) {
feenox_push_error_message("unkown function '%s'", name);
feenox_push_error_message("unknown function '%s'", name);
return FEENOX_ERROR;
}

Expand Down Expand Up @@ -181,7 +181,7 @@ int feenox_function_set_interpolation(const char *name, const char *type) {

function_t *function = NULL;
if ((function = feenox_get_function_ptr(name)) == NULL) {
feenox_push_error_message("unkown function '%s'", name);
feenox_push_error_message("unknown function '%s'", name);
return FEENOX_ERROR;
}

Expand Down
Loading

0 comments on commit 8c2e75b

Please sign in to comment.