PyInduct Modules Reference¶
Because every feature of PyInduct must have a test case, when you are not sure how
to use something, just look into the tests/
directories, find that feature
and read the tests for it, that will tell you everything you need to know.
Most of the things are already documented though in this document, that is automatically generated using PyInduct’s docstrings.
Click the “modules” (Module Index) link in the top right corner to easily access any PyInduct module, or use this table of contents:
- Core
ApproximationBasis
Base
BaseFraction
ComposedFunctionVector
ConstantComposedFunctionVector
ConstantFunction
Domain
EvalData
Function
Parameters
StackedBase
TransformationInfo
back_project_from_base()
calculate_base_transformation_matrix()
calculate_expanded_base_transformation_matrix()
calculate_scalar_matrix()
calculate_scalar_product_matrix()
change_projection_base()
complex_quadrature()
complex_wrapper()
domain_intersection()
domain_simplification()
dot_product()
dot_product_l2()
find_roots()
generic_scalar_product()
get_base()
get_transformation_info()
get_weight_transformation()
integrate_function()
normalize_base()
project_on_base()
project_on_bases()
project_weights()
real()
sanitize_input()
vectorize_scalar_product()
- Shapefunctions
- Eigenfunctions
AddMulFunction
Base
Domain
FiniteTransformFunction
Function
LambdifiedSympyExpression
SecondOrderDirichletEigenfunction
SecondOrderEigenVector
SecondOrderEigenfunction
SecondOrderOperator
SecondOrderRobinEigenfunction
ShapeFunction
TransformedSecondOrderEigenfunction
find_roots()
generic_scalar_product()
normalize_base()
real()
visualize_roots()
- Registry
- Placeholder
FieldVariable
TestFunction
Base
ConstantFunction
EquationTerm
Function
Input
IntegralTerm
ObserverGain
Placeholder
Product
ScalarFunction
ScalarProductTerm
ScalarTerm
Scalars
SpatialDerivedFieldVariable
SpatialPlaceholder
TemporalDerivedFieldVariable
evaluate_placeholder_function()
get_base()
get_common_form()
get_common_target()
is_registered()
register_base()
sanitize_input()
- Simulation
CanonicalEquation
CanonicalForm
Domain
EmptyInput
EquationTerm
EvalData
FieldVariable
Function
Input
IntegralTerm
ObserverGain
Parameters
ScalarProductTerm
ScalarTerm
Scalars
SimulationInput
SimulationInputSum
SimulationInputVector
StackedBase
StateSpace
TestFunction
WeakFormulation
calculate_scalar_product_matrix()
create_state_space()
domain_intersection()
evaluate_approximation()
get_base()
get_common_form()
get_common_target()
get_sim_result()
get_sim_results()
get_transformation_info()
get_weight_transformation()
integrate_function()
parse_weak_formulation()
parse_weak_formulations()
project_on_bases()
register_base()
sanitize_input()
set_dominant_labels()
simulate_state_space()
simulate_system()
simulate_systems()
vectorize_scalar_product()
- Feedback
- Trajectory
- Visualization
DataPlot
Domain
EvalData
FORCE_MPL_ON_WINDOWS
Function
MplSlicePlot
MplSurfacePlot
PgAnimatedPlot
PgDataPlot
PgLinePlot3d
PgSlicePlot
PgSurfacePlot
color_map
colors
complex_wrapper()
create_animation()
create_colormap()
create_dir()
deregister_base()
get_colors()
mpl_3d_remove_margins()
mpl_activate_latex()
save_2d_pg_plot()
show()
surface_plot()
tear_down()
visualize_functions()
visualize_roots()
- Utils
- Parabolic Module
Contributions to docs¶
All contributions are welcome. If you’d like to improve something, look into the sources if they contain the information you need (if not, please fix them), otherwise the documentation generation needs to be improved (look in the docs/ directory).