Nutils API Reference

Nutils is subdivided in a great number of logical units. Some of these are directly user facing, such as nutils.cli, nutils.mesh and nutils.export. Others are primarily used internally, such as nutils.types, nutils.points and nutils.transform. However, a strict separation does not exist, and which modules are accessed directly depends entirely on the specifics of the application.

The modules are:

• cache
  • Wrapper
    • Wrapper.__weakref__
  • WrapperCache
    • WrapperCache.__weakref__
  • enable()
  • disable()
  • function()
  • Recursion
    • Recursion.resume_index()
    • Recursion.resume()
• cli
  • run()
  • choose()
  • setup()
• debug_flags
• element
  • Reference
    • Reference.__mul__()
    • Reference.trim()
  • EmptyLike
  • SimplexReference
  • PointReference
  • LineReference
  • TriangleReference
  • TetrahedronReference
  • TensorReference
  • Cone
  • OwnChildReference
  • WithChildrenReference
  • MosaicReference
• elementseq
  • References
    • References.from_iter()
    • References.uniform()
    • References.empty()
    • References.__bool__()
    • References.__len__()
    • References.__iter__()
    • References.__getitem__()
    • References.__add__()
    • References.__mul__()
    • References.get()
    • References.take()
    • References.compress()
    • References.repeat()
    • References.product()
    • References.chain()
    • References.children
    • References.edges
    • References.isuniform
    • References.getpoints()
• evaluable
  • equalindex()
  • equalshape()
  • replace()
  • Evaluable
    • Evaluable.dependencies
    • Evaluable.arguments
    • Evaluable.ordereddeps
    • Evaluable.dependencytree
    • Evaluable.asciitree()
    • Evaluable.eval()
    • Evaluable.eval_withtimes()
  • EvaluableConstant
  • SparseArray
  • sum()
  • dot()
  • align()
  • unalign()
  • AsEvaluableArray
    • AsEvaluableArray.as_evaluable_array
    • AsEvaluableArray.__weakref__
  • Array
    • Array.shape
    • Array.ndim
    • Array.dtype
    • Array.sum()
    • Array.dot()
    • Array.assparse
    • Array.as_evaluable_array
  • NPoints
  • Normal
  • Inverse
  • Interpolate
  • Pointwise
    • Pointwise.outer()
  • Cos
    • Cos.evalf
  • Sin
    • Sin.evalf
  • Tan
    • Tan.evalf
  • ArcSin
    • ArcSin.evalf
  • ArcCos
    • ArcCos.evalf
  • ArcTan
    • ArcTan.evalf
  • CosH
    • CosH.evalf
  • SinH
    • SinH.evalf
  • TanH
    • TanH.evalf
  • ArcTanH
    • ArcTanH.evalf
  • Sampled
  • Zeros
  • Guard
  • Find
  • DerivativeTargetBase
  • WithDerivative
  • Argument
  • IdentifierDerivativeTarget
  • Polyval
  • Legendre
  • Choose
  • derivative()
  • prependaxes()
  • appendaxes()
  • replace_arguments()
  • einsum()
  • eval_sparse()
• export
  • mplfigure()
  • vtk()
• expression_v1
  • parse()
  • Namespace
    • Namespace.arg_shapes
    • Namespace.default_geometry_name
    • Namespace.__getstate__()
    • Namespace.__setstate__()
    • Namespace.default_geometry
    • Namespace.__call__()
    • Namespace.copy_()
    • Namespace.__getattr__()
    • Namespace.__setattr__()
    • Namespace.__delattr__()
    • Namespace.__rmatmul__()
• expression_v2
  • Namespace
    • Namespace.define_for()
    • Namespace.copy_()
    • Namespace.__weakref__
• function
  • Lowerable
    • Lowerable.lower()
    • Lowerable.__weakref__
  • Array
    • Array.shape
    • Array.ndim
    • Array.dtype
    • Array.spaces
    • Array.arguments
    • Array.cast()
    • Array.__len__()
    • Array.__iter__()
    • Array.size
    • Array.T
    • Array.sum()
    • Array.prod()
    • Array.dot()
    • Array.normalized()
    • Array.normal()
    • Array.curvature()
    • Array.swapaxes()
    • Array.transpose()
    • Array.add_T()
    • Array.grad()
    • Array.laplace()
    • Array.symgrad()
    • Array.div()
    • Array.curl()
    • Array.dotnorm()
    • Array.tangent()
    • Array.ngrad()
    • Array.nsymgrad()
    • Array.choose()
    • Array.eval()
    • Array.derivative()
    • Array.replace()
    • Array.contains()
    • Array.conjugate()
    • Array.conj()
    • Array.real
    • Array.imag
  • Custom
    • Custom.evalf()
    • Custom.partial_derivative()
  • Argument
    • Argument.name
  • implements()
  • asarray()
  • zeros()
  • ones()
  • eye()
  • levicivita()
  • add()
  • subtract()
  • positive()
  • negative()
  • multiply()
  • divide()
  • floor_divide()
  • reciprocal()
  • power()
  • sqrt()
  • abs()
  • matmul()
  • sign()
  • mod()
  • divmod()
  • cos()
  • sin()
  • tan()
  • arccos()
  • arcsin()
  • arctan()
  • arctan2()
  • cosh()
  • sinh()
  • tanh()
  • arctanh()
  • exp()
  • log()
  • ln()
  • log2()
  • log10()
  • greater()
  • equal()
  • less()
  • min()
  • max()
  • opposite()
  • mean()
  • jump()
  • sum()
  • product()
  • conjugate()
  • conj()
  • real()
  • imag()
  • dot()
  • vdot()
  • trace()
  • norm2()
  • normalized()
  • matmat()
  • inverse()
  • determinant()
  • eig()
  • takediag()
  • diagonalize()
  • cross()
  • outer()
  • transpose()
  • insertaxis()
  • expand_dims()
  • repeat()
  • swapaxes()
  • ravel()
  • unravel()
  • take()
  • get()
  • scatter()
  • kronecker()
  • concatenate()
  • stack()
  • replace_arguments()
  • broadcast_arrays()
  • typecast_arrays()
  • broadcast_shapes()
  • broadcast_to()
  • derivative()
  • grad()
  • curl()
  • normal()
  • dotnorm()
  • tangent()
  • jacobian()
  • J()
  • surfgrad()
  • curvature()
  • div()
  • laplace()
  • symgrad()
  • ngrad()
  • nsymgrad()
  • eval()
  • isarray()
  • rootcoords()
  • Elemwise()
  • piecewise()
  • partition()
  • heaviside()
  • choose()
  • chain()
  • vectorize()
  • add_T()
  • dotarg()
  • Basis
    • Basis.get_support()
    • Basis.get_dofs()
    • Basis.get_ndofs()
    • Basis.get_coefficients()
  • PlainBasis
  • DiscontBasis
  • LegendreBasis
  • MaskedBasis
  • StructuredBasis
  • PrunedBasis
• matrix
  • Matrix
    • Matrix.T
    • Matrix.__add__()
    • Matrix.__matmul__()
    • Matrix.__mul__()
    • Matrix.__neg__()
    • Matrix.__weakref__
    • Matrix.export()
    • Matrix.rowsupp()
    • Matrix.solve()
    • Matrix.solve_leniently()
    • Matrix.submatrix()
  • MatrixError
    • MatrixError.__weakref__
  • BackendNotAvailable
  • ToleranceNotReached
• mesh
  • rectilinear()
  • multipatch()
  • parsegmsh()
  • gmsh()
  • simplex()
  • fromfunc()
  • unitsquare()
• numeric
  • overlapping()
  • full()
  • normdim()
  • get()
  • contract()
  • dot()
  • meshgrid()
  • simplex_grid()
  • normalize()
  • diagonalize()
  • inv()
  • ix()
  • ext()
  • unpack()
  • pack()
  • accumulate()
  • asboolean()
  • invmap()
  • levicivita()
• parallel
  • maxprocs()
  • fork()
  • shempty()
  • shzeros()
  • range
    • range.__weakref__
  • ctxrange()
• points
  • Points
    • Points.coords
    • Points.weights
    • Points.__mul__()
    • Points.product()
    • Points.tri
    • Points.hull
    • Points.onhull
  • CoordsPoints
  • CoordsWeightsPoints
  • CoordsUniformPoints
  • TensorPoints
  • SimplexGaussPoints
  • SimplexBezierPoints
  • TransformPoints
  • ConcatPoints
  • ConePoints
  • gauss1()
  • gauss2()
  • gauss3()
• pointsseq
  • PointsSequence
    • PointsSequence.ndims
    • PointsSequence.from_iter()
    • PointsSequence.uniform()
    • PointsSequence.empty()
    • PointsSequence.npoints
    • PointsSequence.__bool__()
    • PointsSequence.__len__()
    • PointsSequence.__iter__()
    • PointsSequence.__getitem__()
    • PointsSequence.__add__()
    • PointsSequence.__mul__()
    • PointsSequence.get()
    • PointsSequence.take()
    • PointsSequence.compress()
    • PointsSequence.repeat()
    • PointsSequence.product()
    • PointsSequence.chain()
    • PointsSequence.tri
    • PointsSequence.hull
• sample
  • Sample
    • Sample.new()
    • Sample.__init__()
    • Sample.getindex()
    • Sample.get_evaluable_indices()
    • Sample.integrate()
    • Sample.integrate_sparse()
    • Sample.integral()
    • Sample.eval()
    • Sample.eval_sparse()
    • Sample.basis()
    • Sample.asfunction()
    • Sample.tri
    • Sample.hull
    • Sample.subset()
    • Sample.zip()
  • eval_integrals()
  • eval_integrals_sparse()
• solver
  • single_or_multiple()
  • iterable
    • iterable.__weakref__
  • withsolve
    • withsolve.solve()
    • withsolve.solve_withinfo()
  • LineSearch
  • NormBased
  • MedianBased
  • solve_linear()
  • newton
    • newton.__wrapped__
  • minimize
    • minimize.__wrapped__
  • pseudotime
    • pseudotime.__wrapped__
  • thetamethod
    • thetamethod.__wrapped__
  • optimize()
• sparse
  • dtype()
  • ndim()
  • shape()
  • indices()
  • values()
  • extract()
  • empty()
  • result_type()
  • dedup()
  • prune()
  • add()
  • block()
  • take()
  • toarray()
  • fromarray()
• testing
  • PrintHandler
  • parametrize()
  • TestCase
    • TestCase.assertAlmostEqual64()
  • ContextTestCase
• topology
  • Topology
    • Topology.spaces
    • Topology.space_dims
    • Topology.references
    • Topology.ndims
    • Topology.empty()
    • Topology.empty_like()
    • Topology.disjoint_union()
    • Topology.__str__()
    • Topology.get_groups()
    • Topology.take()
    • Topology.compress()
    • Topology.slice()
    • Topology.f_index
    • Topology.f_coords
    • Topology.basis()
    • Topology.sample()
    • Topology.integrate_elementwise()
    • Topology.integrate()
    • Topology.integral()
    • Topology.projection()
    • Topology.project()
    • Topology.refined_by()
    • Topology.refine()
    • Topology.refine_count()
    • Topology.refine_spaces()
    • Topology.refine_spaces_unchecked()
    • Topology.refine_spaces_count()
    • Topology.trim()
    • Topology.subset()
    • Topology.indicator()
    • Topology.locate()
    • Topology.boundary
    • Topology.boundary_spaces()
    • Topology.boundary_spaces_unchecked()
    • Topology.interfaces_spaces()
    • Topology.interfaces_spaces_unchecked()
    • Topology.basis_discont()
  • TransformChainsTopology
    • TransformChainsTopology.sample()
    • TransformChainsTopology.basis_lagrange()
    • TransformChainsTopology.basis_bernstein()
    • TransformChainsTopology.basis_std()
  • WithGroupsTopology
  • OppositeTopology
  • EmptyTopology
  • StructuredTopology
    • StructuredTopology.__init__()
    • StructuredTopology.boundary
    • StructuredTopology.interfaces
    • StructuredTopology.basis_spline()
    • StructuredTopology.refined
    • StructuredTopology.__str__()
  • ConnectedTopology
  • SimplexTopology
    • SimplexTopology.basis_bubble()
  • UnionTopology
  • DisjointUnionTopology
  • SubsetTopology
  • RefinedTopology
  • HierarchicalTopology
    • HierarchicalTopology.__init__()
    • HierarchicalTopology.boundary
    • HierarchicalTopology.interfaces
    • HierarchicalTopology.basis()
  • MultipatchTopology
    • MultipatchTopology.build_boundarydata()
    • MultipatchTopology.__init__()
    • MultipatchTopology.basis_spline()
    • MultipatchTopology.basis_patch()
    • MultipatchTopology.boundary
    • MultipatchTopology.interfaces
    • MultipatchTopology.refined
• transform
  • TransformItem
  • Matrix
  • Square
  • Identity
  • Index
  • Updim
  • EvaluableTransformChain
    • EvaluableTransformChain.todims
    • EvaluableTransformChain.fromdims
    • EvaluableTransformChain.empty()
    • EvaluableTransformChain.from_argument()
    • EvaluableTransformChain.linear
    • EvaluableTransformChain.basis
    • EvaluableTransformChain.apply()
    • EvaluableTransformChain.index_with_tail_in()
• transformseq
  • Transforms
    • Transforms.todims
    • Transforms.fromdims
    • Transforms.__len__()
    • Transforms.__getitem__()
    • Transforms.index_with_tail()
    • Transforms.__iter__()
    • Transforms.index()
    • Transforms.contains()
    • Transforms.__contains__()
    • Transforms.contains_with_tail()
    • Transforms.refined()
    • Transforms.edges()
    • Transforms.__add__()
    • Transforms.unchain()
    • Transforms.get_evaluable()
  • EmptyTransforms
  • PlainTransforms
  • IndexTransforms
  • Axis
  • StructuredTransforms
  • MaskedTransforms
  • ReorderedTransforms
  • DerivedTransforms
  • UniformDerivedTransforms
  • ChainedTransforms
  • chain()
• types
  • aspreprocessor()
  • apply_annotations()
  • argument_canonicalizer()
  • nutils_hash()
  • CacheMeta
  • Immutable
  • Singleton
    • Singleton.__eq__()
  • arraydata
  • strictint()
  • strictfloat()
  • strictstr()
  • strict
    • strict.__weakref__
  • tuple
  • frozendict
  • frozenmultiset
    • frozenmultiset.__and__()
    • frozenmultiset.__add__()
    • frozenmultiset.__sub__()
  • frozenarray()
  • c_array
    • c_array.__weakref__
  • lru_cache()
  • attributes
    • attributes.__weakref__
  • hashable_function()
• unit
  • create()
• util
  • NanVec
  • tri_merge()
  • tri_interpolator
    • tri_interpolator.__weakref__
  • obj2str()
  • single_or_multiple
    • single_or_multiple.__weakref__
  • positional_only
    • positional_only.__weakref__
  • loadlib()
  • readtext()
  • binaryfile()
  • settable
  • index()
  • unique()
• warnings
  • NutilsWarning
    • NutilsWarning.__weakref__
  • NutilsDeprecationWarning
  • NutilsInefficiencyWarning
  • via
    • via.__weakref__