C to Julia name index

The high-level interface renames PETSc's C functions to Julia conventions (see the naming conventions), which costs discoverability: someone who knows PetscFECopyQuadrature cannot grep for it once it is copy_quadrature!. This page is the lookup table in the other direction.

It is generated at docs build time from the doc_external entries in the high-level docstrings, so it cannot drift from them: a wrapper that links a C page appears here, and one that does not is a docstring bug rather than a missing table row.

199 C functions are covered.

C function	Julia
`DMAddBoundary`	`PETSc.add_boundary!`, `PETSc.add_natural_boundary!`
`DMClone`	`PETSc.clone`
`DMComputeL2Diff`	`PETSc.l2diff`
`DMCopyDisc`	`PETSc.copy_disc!`
`DMCreateDS`	`PETSc.create_ds!`
`DMCreateMatrix`	`PETSc.PetscMat`
`DMDA`	`PETSc.DMDA`
`DMDACreate1d`	`PETSc.DMDA`
`DMDACreate2d`	`PETSc.DMDA`
`DMDACreate3d`	`PETSc.DMDA`
`DMDAGetCorners`	`PETSc.corners`
`DMDAGetDof`	`PETSc.ndofs`
`DMDAGetGhostCorners`	`PETSc.ghost_corners`
`DMDAGetInfo`	`Base.size`, `PETSc.info`
`DMDASetUniformCoordinates`	`PETSc.set_uniform_coordinates!`
`DMDestroy`	`PETSc.destroy!`
`DMGetCoarseDM`	`PETSc.coarse_dm`
`DMGetCoordinatesLocal`	`PETSc.local_coordinate_array`, `PETSc.local_coordinates`
`DMGetDimension`	`Base.ndims`, `PETSc.narrow`
`DMGetDS`	`PETSc.ds`
`DMGetLabel`	`PETSc.label`
`DMGetType`	`PETSc.narrow`, `PETSc.type_name`
`DMGlobalToLocal`	`PETSc.global_to_local!`
`DMLocalToGlobal`	`PETSc.local_to_global!`
`DMLocalToLocalBegin`	`PETSc.local_to_local!`
`DMLocalToLocalEnd`	`PETSc.local_to_local!`
`DMPLEX`	`PETSc.DMPlex`
`DMPlexCreate`	`PETSc.DMPlex`
`DMPlexCreateBoxMesh`	`PETSc.DMPlex`
`DMPlexDistribute`	`PETSc.distribute!`
`DMPlexIsSimplex`	`PETSc.issimplex`
`DMPlexSetSNESLocalFEM`	`PETSc.set_snes_local_fem!`
`DMProjectField`	`PETSc.project_field!`
`DMProjectFunction`	`PETSc.project_function!`
`DMSetField`	`PETSc.set_field!`
`DMSetFromOptions`	`PETSc.DMPlex`, `PETSc.set_from_options!`
`DMSetMatrixPreallocateOnly`	`PETSc.set_matrix_preallocate_only!`
`DMSetType`	`PETSc.DMPlex`, `PETSc.set_type!`
`DMSetUp`	`PETSc.setup!`
`DMSTAG`	`PETSc.DMStag`
`DMStagCreate1d`	`PETSc.DMStag`
`DMStagCreate2d`	`PETSc.DMStag`
`DMStagCreate3d`	`PETSc.DMStag`
`DMStagCreateCompatibleDMStag`	`PETSc.DMStag`
`DMStagCreateISFromStencils`	`LibPETSc.IS`
`DMStagGetCorners`	`PETSc.corners`
`DMStagGetGhostCorners`	`PETSc.ghost_corners`
`DMStagGetGlobalSizes`	`Base.size`
`DMStagGetLocationSlot`	`PETSc.with_field_views!`
`DMStagGetProductCoordinateArraysRead`	`PETSc.with_product_coordinates`
`DMStagMatSetValuesStencil`	`PETSc.set_values!`
`DMStagRestoreProductCoordinateArraysRead`	`PETSc.with_product_coordinates`
`DMStagSetUniformCoordinatesProduct`	`PETSc.set_uniform_coordinates!`
`DMStagStencil`	`PETSc.@inline`
`DMStagStencilLocation`	`PETSc.edge_location`, `PETSc.element_location`, `PETSc.face_location`, `PETSc.on_lower_side`, `PETSc.vertex_location`
`DMStagStencilToIndexLocal`	`PETSc.zero_rows_local!`
`DMStagVecGetArray`	`PETSc.with_field_views!`
`DMStagVecSetValuesStencil`	`PETSc.set_values!`
`KSPCreate`	`PETSc.KSP`
`KSPDestroy`	`PETSc.destroy!`
`KSPGetConvergedReason`	`PETSc.converged_reason`
`KSPGetDM`	`PETSc.dm`
`KSPGetIterationNumber`	`PETSc.iteration_number`
`KSPGetOptionsPrefix`	`PETSc.options_prefix`
`KSPGetSolution`	`PETSc.solution`
`KSPGetType`	`PETSc.type_name`
`KSPSetComputeOperators`	`PETSc.set_compute_operators!`
`KSPSetComputeRHS`	`PETSc.set_compute_rhs!`
`KSPSetDM`	`PETSc.KSP`
`KSPSetDMActive`	`PETSc.set_dm_active!`
`KSPSetFromOptions`	`PETSc.KSP`, `PETSc.set_from_options!`
`KSPSetOperators`	`PETSc.KSP`, `PETSc.set_operators!`
`KSPSetOptionsPrefix`	`PETSc.set_options_prefix!`
`KSPSetType`	`PETSc.set_type!`
`MatAssembled`	`PETSc.isassembled`
`MatCreateSeqAIJ`	`PETSc.PetscMat`
`MatCreateSeqAIJWithArrays`	`PETSc.PetscMat`
`MatCreateSeqDense`	`PETSc.PetscMat`
`MatCreateShell`	`PETSc.MatShell`
`MatDestroy`	`PETSc.destroy!`
`MatGetDiagonal`	`PETSc.diagonal!`
`MatGetOwnershipRange`	`PETSc.ownership_range`
`MatGetType`	`PETSc.type_name`
`MatNullSpaceDestroy`	`PETSc.destroy!`
`MATOP_MULT`	`PETSc.MatShell`
`MatSetOption`	`PETSc.set_option!`
`MatSetType`	`PETSc.set_type!`
`MatSetUp`	`PETSc.setup!`
`MatSetValues`	`PETSc.set_values!`
`MatSetValuesStencil`	`PETSc.set_values!`
`MatShellSetOperation`	`PETSc.MatShell`
`MatZeroEntries`	`Base.fill!`
`MatZeroRows`	`PETSc.zero_rows!`
`MatZeroRowsLocal`	`PETSc.zero_rows_local!`
`PCGetOptionsPrefix`	`PETSc.options_prefix`
`PCSetOptionsPrefix`	`PETSc.set_options_prefix!`
`PetscDSSetConstants`	`PETSc.set_constants!`
`PetscDSSetExactSolution`	`PETSc.set_exact_solution!`
`PetscDSSetJacobian`	`PETSc.set_jacobian!`
`PetscDSSetJacobianPreconditioner`	`PETSc.set_jacobian_preconditioner!`
`PetscDSSetResidual`	`PETSc.set_residual!`
`PetscFECreateDefault`	`PETSc.fe_create_default`
`PetscFECreateLagrange`	`PETSc.fe_create_lagrange`
`PetscFinalize`	`PETSc.finalize`
`PetscFinalized`	`PETSc.isfinalized`
`PetscInitialize`	`PETSc.initialize`
`PetscInitialized`	`PETSc.isinitialized`
`PetscObjectGetComm`	`PETSc.comm`
`PetscObjectSetName`	`PETSc.set_name!`
`PetscOptionsCreate`	`PETSc.PetscOptions`
`PetscViewerVTKOpen`	`PETSc.save_vtk`
`PetscWeakFormSetIndexBdResidual`	`PETSc.add_natural_boundary!`
`SNESCreate`	`PETSc.SNES`
`SNESDestroy`	`PETSc.destroy!`
`SNESGetConvergedReason`	`PETSc.converged_reason`
`SNESGetDM`	`PETSc.dm`
`SNESGetFunctionNorm`	`PETSc._norm`
`SNESGetIterationNumber`	`PETSc.iteration_number`
`SNESGetKSP`	`PETSc.ksp`
`SNESGetLinearSolveIterations`	`PETSc.ksp_iterations`
`SNESGetOptionsPrefix`	`PETSc.options_prefix`
`SNESGetSolution`	`PETSc.solution`
`SNESGetType`	`PETSc.type_name`
`SNESSetConvergenceTest`	`PETSc.set_convergence_test!`
`SNESSetDM`	`PETSc.set_dm!`
`SNESSetFromOptions`	`PETSc.SNES`, `PETSc.set_from_options!`
`SNESSetFunction`	`PETSc.set_function!`
`SNESSetFunctionDomainError`	`PETSc.set_function_domain_error!`
`SNESSetJacobian`	`PETSc.set_snes_jacobian!`
`SNESSetOptionsPrefix`	`PETSc.set_options_prefix!`
`SNESSetSolution`	`PETSc.set_solution!`
`SNESSetType`	`PETSc.set_type!`
`TSAdaptSetType`	`PETSc.set_adapt_type!`
`TSCreate`	`PETSc.TS`
`TSDestroy`	`PETSc.destroy!`
`TSGetConvergedReason`	`PETSc.converged_reason`
`TSGetDM`	`PETSc.dm`
`TSGetEquationType`	`PETSc.equation_type`
`TSGetKSP`	`PETSc.ksp`
`TSGetKSPIterations`	`PETSc.ksp_iterations`
`TSGetMaxSteps`	`PETSc.max_steps`
`TSGetMaxTime`	`PETSc.max_time`
`TSGetOptionsPrefix`	`PETSc.options_prefix`
`TSGetPrevTime`	`PETSc.prev_time`
`TSGetSNES`	`PETSc.snes`
`TSGetSNESFailures`	`PETSc.snes_failures`
`TSGetSNESIterations`	`PETSc.snes_iterations`
`TSGetSolution`	`PETSc.solution`
`TSGetSolveTime`	`PETSc.solve_time`
`TSGetStepNumber`	`PETSc.step_number`
`TSGetStepRejections`	`PETSc.step_rejections`
`TSGetTime`	`PETSc.current_time`
`TSGetTimeStep`	`PETSc.timestep`
`TSGetTolerances`	`PETSc.tolerances`
`TSGetType`	`PETSc.type_name`
`TSInterpolate`	`PETSc.interpolate!`
`TSMonitorSet`	`PETSc.set_monitor!`
`TSReset`	`PETSc.reset!`
`TSSetDM`	`PETSc.set_dm!`
`TSSetEquationType`	`PETSc.set_equation_type!`
`TSSetErrorIfStepFails`	`PETSc.set_error_if_step_fails!`
`TSSetExactFinalTime`	`PETSc.TS`, `PETSc.set_exact_final_time!`
`TSSetFromOptions`	`PETSc.set_from_options!`
`TSSetIFunction`	`PETSc.set_ifunction!`
`TSSetIJacobian`	`PETSc.set_ijacobian!`
`TSSetMaxSNESFailures`	`PETSc.set_max_snes_failures!`
`TSSetMaxStepRejections`	`PETSc.set_max_step_rejections!`
`TSSetMaxSteps`	`PETSc.set_max_steps!`
`TSSetMaxTime`	`PETSc.set_max_time!`
`TSSetOptionsPrefix`	`PETSc.set_options_prefix!`
`TSSetPostStep`	`PETSc.set_post_step!`
`TSSetPreStep`	`PETSc.set_pre_step!`
`TSSetProblemType`	`PETSc.set_problem_type!`
`TSSetRHSFunction`	`PETSc.set_rhs_function!`
`TSSetRHSJacobian`	`PETSc.set_rhs_jacobian!`
`TSSetSolution`	`PETSc.set_solution!`, `PETSc.solve!`
`TSSetStepNumber`	`PETSc.set_step_number!`
`TSSetTime`	`PETSc.set_time!`
`TSSetTimeStep`	`PETSc.set_timestep!`
`TSSetTolerances`	`PETSc.set_tolerances!`
`TSSetType`	`PETSc.set_type!`
`TSSetUp`	`PETSc.setup!`
`TSSolve`	`LibPETSc.TSSolve`, `PETSc.solve!`
`TSStep`	`PETSc.step!`
`VecCopy`	`Base.copyto!`
`VecCreateSeq`	`PETSc.PetscVec`
`VecCreateSeqWithArray`	`PETSc.PetscVec`
`VecDestroy`	`PETSc.destroy!`
`VecGetArray`	`PETSc.unsafe_local_array`
`VecGetArrayRead`	`PETSc.unsafe_local_array`
`VecGetArrayWrite`	`PETSc.unsafe_local_array`
`VecGetOwnershipRange`	`PETSc.ownership_range`
`VecGetType`	`PETSc.type_name`
`VecGhostUpdateBegin`	`PETSc.ghost_update_begin!`
`VecGhostUpdateEnd`	`PETSc.ghost_update!`, `PETSc.ghost_update_end!`
`VecRestoreArray`	`PETSc.unsafe_local_array`
`VecRestoreArrayRead`	`PETSc.unsafe_local_array`
`VecRestoreArrayWrite`	`PETSc.unsafe_local_array`
`VecSetType`	`PETSc.set_type!`