From 25bc7dec0bed5578ad036344bd5085f9e014a2f6 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Wed, 28 Aug 2024 15:43:42 +0000 Subject: [PATCH] build based on 5261fd4 --- dev/.documenter-siteinfo.json | 2 +- dev/fulldocs/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 0a21ffb..8d6a822 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-08-28T15:43:28","documenter_version":"1.6.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.2","generation_timestamp":"2024-08-28T15:43:40","documenter_version":"1.6.0"}} \ No newline at end of file diff --git a/dev/fulldocs/index.html b/dev/fulldocs/index.html index 50e3560..b7bedbc 100644 --- a/dev/fulldocs/index.html +++ b/dev/fulldocs/index.html @@ -1,2 +1,2 @@ -Full documentation · TaylorInterface.jl
GitHub

Full documentation

Main structures

TaylorInterface.TaylorGenerator — Type
TaylorGenerator(name=randstring(12), eqs_filename, parent_path=".")

Structure used to generate directories and call taylor. The directory name will be $(parent_path)/taylor_$(name). The equation file should follow the syntax required by taylor.

source

Around the TaylorGenerator

TaylorInterface.generate_dir — Function
generate_dir(generator, silent=false)

Generates the directory corresponding to the generator, and builds the library. If silent is true, command will be silent apart from errors.

source
TaylorInterface.get_handler — Function
get_handler(generator, open=true)

Get the TaylorHandler corresponding to the generator. If open is true, the library will also be open in the handler.

source

Around the TaylorHandler

TaylorInterface.compile_eqs — Function
compile_eqs(generator, silent=false)

Runs make in the directory of the generator. If silent is true, runs make -s, thus being silent (apart from errors).

source
compile_eqs(handler, silent=false)

Runs make in the directory of the handler. If silent is true, runs make -s, thus being silent (apart from errors).

source
TaylorInterface.open_lib — Function
open_lib(handler)

Opens the handler's library, storing the loaded library and a dictionary with symbols to functions in the handler.

Currently, the loaded functions are flow, tstep and tstep_reverse.

source

Integration functions

TaylorInterface.flow! — Function
flow!(han, x, [y], t, df=Ref(nothing))

Wrapper function around the C flow function in the han TaylorHandler.

df should be passed as a vector if jet transport is used. In this case, jet transport results will be stored in df.

If y is passed, the flow result will be stored in it.

source
TaylorInterface.flow — Function
flow(han, x, t)

Wrapper function around the C flow function in the han TaylorHandler. Should only be used if jet transport isn't used; otherwise, use flow!.

source

Default models

TaylorInterface.get_model — Function
get_model(name, open=false)

Get the TaylorHandler corresponding to a default model in this package. If open is true, the library will also be open in the handler.

Warning: name should NOT contain the prefix "taylor_h".

source

Internal functions

File system navigation

These functions are mainly intended for internal use and navigation within the file system.

Taylor flags

+Full documentation · TaylorInterface.jl
GitHub

Full documentation

Main structures

TaylorInterface.TaylorGenerator — Type
TaylorGenerator(name=randstring(12), eqs_filename, parent_path=".")

Structure used to generate directories and call taylor. The directory name will be $(parent_path)/taylor_$(name). The equation file should follow the syntax required by taylor.

source

Around the TaylorGenerator

TaylorInterface.generate_dir — Function
generate_dir(generator, silent=false)

Generates the directory corresponding to the generator, and builds the library. If silent is true, command will be silent apart from errors.

source
TaylorInterface.get_handler — Function
get_handler(generator, open=true)

Get the TaylorHandler corresponding to the generator. If open is true, the library will also be open in the handler.

source

Around the TaylorHandler

TaylorInterface.compile_eqs — Function
compile_eqs(generator, silent=false)

Runs make in the directory of the generator. If silent is true, runs make -s, thus being silent (apart from errors).

source
compile_eqs(handler, silent=false)

Runs make in the directory of the handler. If silent is true, runs make -s, thus being silent (apart from errors).

source
TaylorInterface.open_lib — Function
open_lib(handler)

Opens the handler's library, storing the loaded library and a dictionary with symbols to functions in the handler.

Currently, the loaded functions are flow, tstep and tstep_reverse.

source

Integration functions

TaylorInterface.flow! — Function
flow!(han, x, [y], t, df=Ref(nothing))

Wrapper function around the C flow function in the han TaylorHandler.

df should be passed as a vector if jet transport is used. In this case, jet transport results will be stored in df.

If y is passed, the flow result will be stored in it.

source
TaylorInterface.flow — Function
flow(han, x, t)

Wrapper function around the C flow function in the han TaylorHandler. Should only be used if jet transport isn't used; otherwise, use flow!.

source

Default models

TaylorInterface.get_model — Function
get_model(name, open=false)

Get the TaylorHandler corresponding to a default model in this package. If open is true, the library will also be open in the handler.

Warning: name should NOT contain the prefix "taylor_h".

source

Internal functions

File system navigation

These functions are mainly intended for internal use and navigation within the file system.

Taylor flags