From b1d34df5e94e2182b3aababe7c9dbfafd4ab7ebc Mon Sep 17 00:00:00 2001 From: aldoclemente Date: Mon, 15 Jan 2024 09:37:17 +0000 Subject: [PATCH] Update documentation --- DESCRIPTION | 2 +- man/DiffusionOperator.Rd | 6 +++--- man/Mesh.Rd | 2 +- man/grad.Rd | 6 +++--- man/lake_como_boundary.Rd | 8 ++++++++ man/pde.Rd | 2 +- 6 files changed, 17 insertions(+), 9 deletions(-) create mode 100644 man/lake_como_boundary.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 8635e69..a05e474 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,7 +23,7 @@ License: GPL (>= 2) URL: https://github.com/fdaPDE/femR, https://fdapde.github.io/femR/ Imports: Rcpp (>= 1.0.7), RcppEigen LinkingTo: Rcpp, RcppEigen -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.0 SystemRequirements: GNU make Encoding: UTF-8 Suggests: diff --git a/man/DiffusionOperator.Rd b/man/DiffusionOperator.Rd index b969489..600fc77 100644 --- a/man/DiffusionOperator.Rd +++ b/man/DiffusionOperator.Rd @@ -5,12 +5,12 @@ \alias{div} \title{laplace operator for Function class} \usage{ -laplace(f) +laplace(Function) -div(f) +div(Function) } \arguments{ -\item{f}{a Function.} +\item{Function}{a Function.} } \value{ A S4 object representing the laplace operator applied to the function passed as parameter. diff --git a/man/Mesh.Rd b/man/Mesh.Rd index dbe8770..d48705b 100644 --- a/man/Mesh.Rd +++ b/man/Mesh.Rd @@ -22,7 +22,7 @@ Mesh(domain) }} } \value{ -An S4 object representing a Mesh. +A R6 class representing a Mesh. } \description{ Mesh diff --git a/man/grad.Rd b/man/grad.Rd index 8d2652a..4b28678 100644 --- a/man/grad.Rd +++ b/man/grad.Rd @@ -5,12 +5,12 @@ \alias{grad,Function-method} \title{Function gradient} \usage{ -grad(f) +grad(Function) -\S4method{grad}{Function}(f) +\S4method{grad}{Function}(Function) } \arguments{ -\item{f}{a Function created by \code{Function}:} +\item{Function}{a Function created by \code{Function}:} } \value{ An S4 object representing the gradient of the Function passed as parameter. diff --git a/man/lake_como_boundary.Rd b/man/lake_como_boundary.Rd new file mode 100644 index 0000000..08e4518 --- /dev/null +++ b/man/lake_como_boundary.Rd @@ -0,0 +1,8 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/datasets.R +\name{lake_como_boundary} +\alias{lake_como_boundary} +\title{Lake Como boundary} +\description{ +sf object storing the boundary of Lake Como. +} diff --git a/man/pde.Rd b/man/pde.Rd index 5b9cd27..8ebaaed 100644 --- a/man/pde.Rd +++ b/man/pde.Rd @@ -9,7 +9,7 @@ \usage{ Pde(DifferentialOp, f) -\S4method{Pde}{DiffOpObject,`function`}(DifferentialOp, f) +\S4method{Pde}{DiffOpObject,function}(DifferentialOp, f) \S4method{Pde}{DiffOpObject,numeric}(DifferentialOp, f) }