petsc4py.PETSc.Space¶

class petsc4py.PETSc.Space¶

Bases: Object

Linear space object.

Enumerations

Type

Methods Summary

`create`([comm])	Create an empty `Space` object.
`destroy`()	Destroy the `Space` object.
`getDegree`()	Return the polynomial degrees that characterize this space.
`getDimension`()	Return the number of basis vectors.
`getNumComponents`()	Return the number of components for this space.
`getNumVariables`()	Return the number of variables for this space.
`getPTrimmedFormDegree`()	Return the form degree of the trimmed polynomials.
`getPointPoints`()	Return the evaluation points for the space as the points of a quad.
`getPolynomialTensor`()	Return whether a function space is a space of tensor polynomials.
`getSumConcatenate`()	Return the concatenate flag for this space.
`getSumNumSubspaces`()	Return the number of spaces in the sum.
`getSumSubspace`(s)	Return a space in the sum.
`getTensorNumSubspaces`()	Return the number of spaces in the tensor product.
`getTensorSubspace`(s)	Return a space in the tensor product.
`getType`()	Return the type of the space object.
`setDegree`(degree, maxDegree)	Set the degree of approximation for this space.
`setFromOptions`()	Set parameters in `Space` from the options database.
`setNumComponents`(nc)	Set the number of components for this space.
`setNumVariables`(n)	Set the number of variables for this space.
`setPTrimmedFormDegree`(formDegree)	Set the form degree of the trimmed polynomials.
`setPointPoints`(quad)	Set the evaluation points for the space to be based on a quad.
`setPolynomialTensor`(tensor)	Set whether a function space is a space of tensor polynomials.
`setSumConcatenate`(concatenate)	Set the concatenate flag for this space.
`setSumNumSubspaces`(numSumSpaces)	Set the number of spaces in the sum.
`setSumSubspace`(s, subsp)	Set a space in the sum.
`setTensorNumSubspaces`(numTensSpaces)	Set the number of spaces in the tensor product.
`setTensorSubspace`(s, subsp)	Set a space in the tensor product.
`setType`(space_type)	Build a particular type of space.
`setUp`()	Construct data structures for the `Space`.
`view`([viewer])	View a `Space`.
`viewFromOptions`(name[, obj])	View a `Space` based on values in the options database.

Methods Documentation

create(comm=None)¶

Create an empty Space object.

Collective.

The type can then be set with setType.

Parameters:: comm (Comm | None) – MPI communicator, defaults to Sys.getDefaultComm.
Return type:: Self

See also

petsc.PetscSpaceCreate

Source code at petsc4py/PETSc/Space.pyx:34

destroy()¶

Destroy the Space object.

Collective.

See also

petsc.PetscSpaceDestroy

Source code at petsc4py/PETSc/Space.pyx:57

Return type:: Self

getDegree()¶

Return the polynomial degrees that characterize this space.

Returns:

minDegree (int) – The degree of the largest polynomial space contained in the space.
maxDegree (int) – The degree of the smallest polynomial space containing the space.

Return type:

tuple[int, int]

See also

setDegree, petsc.PetscSpaceGetDegree

Source code at petsc4py/PETSc/Space.pyx:113

getDimension()¶

Return the number of basis vectors.

See also

petsc.PetscSpaceGetDimension

Source code at petsc4py/PETSc/Space.pyx:101

Return type:: int

getNumComponents()¶

Return the number of components for this space.

See also

setNumComponents, petsc.PetscSpaceGetNumComponents

Source code at petsc4py/PETSc/Space.pyx:184

Return type:: int

getNumVariables()¶

Return the number of variables for this space.

See also

setNumVariables, petsc.PetscSpaceGetNumVariables

Source code at petsc4py/PETSc/Space.pyx:156

Return type:: int

getPTrimmedFormDegree()¶

Return the form degree of the trimmed polynomials.

See also

setPTrimmedFormDegree, petsc.PetscSpacePTrimmedGetFormDegree

Source code at petsc4py/PETSc/Space.pyx:515

Return type:: int

getPointPoints()¶

Return the evaluation points for the space as the points of a quad.

Logically collective.

See also

setPointPoints, petsc.PetscSpacePointGetPoints

Source code at petsc4py/PETSc/Space.pyx:485

Return type:: Quad

getPolynomialTensor()¶

Return whether a function space is a space of tensor polynomials.

Return True if a function space is a space of tensor polynomials (the space is spanned by polynomials whose degree in each variable is bounded by the given order), as opposed to polynomials (the space is spanned by polynomials whose total degree—summing over all variables is bounded by the given order).

See also

setPolynomialTensor, petsc.PetscSpacePolynomialGetTensor

Source code at petsc4py/PETSc/Space.pyx:424

Return type:: bool

getSumConcatenate()¶

Return the concatenate flag for this space.

A concatenated sum space will have the number of components equal to the sum of the number of components of all subspaces. A non-concatenated, or direct sum space will have the same number of components as its subspaces.

See also

setSumConcatenate, petsc.PetscSpaceSumGetConcatenate

Source code at petsc4py/PETSc/Space.pyx:257

Return type:: bool

getSumNumSubspaces()¶

Return the number of spaces in the sum.

See also

setSumNumSubspaces, petsc.PetscSpaceSumGetNumSubspaces

Source code at petsc4py/PETSc/Space.pyx:296

Return type:: int

getSumSubspace(s)¶

Return a space in the sum.

Parameters:: s (int) – The space number.
Return type:: Space

See also

setSumSubspace, petsc.PetscSpaceSumGetSubspace

Source code at petsc4py/PETSc/Space.pyx:308

getTensorNumSubspaces()¶

Return the number of spaces in the tensor product.

See also

setTensorNumSubspaces, petsc.PetscSpaceTensorGetNumSubspaces

Source code at petsc4py/PETSc/Space.pyx:360

Return type:: int

getTensorSubspace(s)¶

Return a space in the tensor product.

Parameters:: s (int) – The space number.
Return type:: Space

See also

setTensorSubspace, petsc.PetscSpaceTensorGetSubspace

Source code at petsc4py/PETSc/Space.pyx:390

getType()¶

Return the type of the space object.

Not collective.

See also

setType, petsc.PetscSpaceGetType

Source code at petsc4py/PETSc/Space.pyx:223

Return type:: str

setDegree(degree, maxDegree)¶

Set the degree of approximation for this space.

One of degree and maxDegree can be None.

Parameters:

degree (int | None) – The degree of the largest polynomial space contained in the space.
maxDegree (int | None) – The degree of the largest polynomial space containing the space.

Return type:

None

See also

getDegree, petsc.PetscSpaceSetDegree

Source code at petsc4py/PETSc/Space.pyx:132

setFromOptions()¶

Set parameters in Space from the options database.

Collective.

See also

Working with PETSc options (TODO), petsc.PetscSpaceSetFromOptions

Source code at petsc4py/PETSc/Space.pyx:89

Return type:: None

setNumComponents(nc)¶

Set the number of components for this space.

Parameters:: nc (int) – The number of components.
Return type:: None

See also

getNumComponents, petsc.PetscSpaceSetNumComponents

Source code at petsc4py/PETSc/Space.pyx:196

setNumVariables(n)¶

Set the number of variables for this space.

Parameters:: n (int) – The number of variables (x, y, z etc.).
Return type:: None

See also

getNumVariables, petsc.PetscSpaceSetNumVariables

Source code at petsc4py/PETSc/Space.pyx:168

setPTrimmedFormDegree(formDegree)¶

Set the form degree of the trimmed polynomials.

Parameters:: formDegree (int) – The form degree.
Return type:: None

See also

getPTrimmedFormDegree, petsc.PetscSpacePTrimmedSetFormDegree

Source code at petsc4py/PETSc/Space.pyx:499

setPointPoints(quad)¶

Set the evaluation points for the space to be based on a quad.

Logically collective.

Sets the evaluation points for the space to coincide with the points of a quadrature rule.

Parameters:: quad (Quad) – The Quad defining the points.
Return type:: None

See also

getPointPoints, petsc.PetscSpacePointSetPoints

Source code at petsc4py/PETSc/Space.pyx:465

setPolynomialTensor(tensor)¶

Set whether a function space is a space of tensor polynomials.

Set to True for a function space which is a space of tensor polynomials (the space is spanned by polynomials whose degree in each variable is bounded by the given order), as opposed to polynomials (the space is spanned by polynomials whose total degree—summing over all variables is bounded by the given order).