petsc4py.PETSc.Space
- class petsc4py.PETSc.Space
Bases:
Object
Linear space object.
Enumerations
Methods Summary
create
([comm])Create an empty
Space
object.destroy
()Destroy the
Space
object.Return the polynomial degrees that characterize this space.
Return the number of basis vectors.
Return the number of components for this space.
Return the number of variables for this space.
Return the form degree of the trimmed polynomials.
Return the evaluation points for the space as the points of a quad.
Return whether a function space is a space of tensor polynomials.
Return the concatenate flag for this space.
Return the number of spaces in the sum.
Return a space in the sum.
Return the number of spaces in the tensor product.
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.
Set parameters in
Space
from the options database.setNumComponents
(nc)Set the number of components for this space.
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:
See also
petsc.PetscSpaceCreate
- destroy()
Destroy the
Space
object.Collective.
See also
petsc.PetscSpaceDestroy
Source code at petsc4py/PETSc/Space.pyx:57
- Return type:
- getDegree()
Return the polynomial degrees that characterize this space.
- Returns:
- Return type:
See also
setDegree
,petsc.PetscSpaceGetDegree
- getDimension()
Return the number of basis vectors.
See also
petsc.PetscSpaceGetDimension
Source code at petsc4py/PETSc/Space.pyx:101
- Return type:
- getNumComponents()
Return the number of components for this space.
See also
setNumComponents
,petsc.PetscSpaceGetNumComponents
Source code at petsc4py/PETSc/Space.pyx:184
- Return type:
- getNumVariables()
Return the number of variables for this space.
See also
setNumVariables
,petsc.PetscSpaceGetNumVariables
Source code at petsc4py/PETSc/Space.pyx:156
- Return type:
- getPTrimmedFormDegree()
Return the form degree of the trimmed polynomials.
See also
setPTrimmedFormDegree
,petsc.PetscSpacePTrimmedGetFormDegree
Source code at petsc4py/PETSc/Space.pyx:515
- Return type:
- 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:
- 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:
- 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:
- getSumNumSubspaces()
Return the number of spaces in the sum.
See also
setSumNumSubspaces
,petsc.PetscSpaceSumGetNumSubspaces
Source code at petsc4py/PETSc/Space.pyx:296
- Return type:
- getSumSubspace(s)
Return a space in the sum.
See also
setSumSubspace
,petsc.PetscSpaceSumGetSubspace
- 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:
- getTensorSubspace(s)
Return a space in the tensor product.
See also
setTensorSubspace
,petsc.PetscSpaceTensorGetSubspace
- 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:
- setDegree(degree, maxDegree)
Set the degree of approximation for this space.
One of
degree
andmaxDegree
can beNone
.- Parameters:
- Return type:
See also
getDegree
,petsc.PetscSpaceSetDegree
- 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:
- setNumComponents(nc)
Set the number of components for this space.
See also
getNumComponents
,petsc.PetscSpaceSetNumComponents
- setNumVariables(n)
Set the number of variables for this space.
See also
getNumVariables
,petsc.PetscSpaceSetNumVariables
- setPTrimmedFormDegree(formDegree)
Set the form degree of the trimmed polynomials.
See also
getPTrimmedFormDegree
,petsc.PetscSpacePTrimmedSetFormDegree
- 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.
See also
getPointPoints
,petsc.PetscSpacePointSetPoints
- 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).- Parameters:
tensor (bool) –
True
for a tensor polynomial space,False
for a polynomial space.- Return type:
See also
getPolynomialTensor
,petsc.PetscSpacePolynomialSetTensor
- setSumConcatenate(concatenate)
Set 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.
- Parameters:
concatenate (bool) –
True
if subspaces are concatenated components,False
if direct summands.- Return type:
See also
getSumConcatenate
,petsc.PetscSpaceSumSetConcatenate
- setSumNumSubspaces(numSumSpaces)
Set the number of spaces in the sum.
See also
getSumNumSubspaces
,petsc.PetscSpaceSumSetNumSubspaces
- setSumSubspace(s, subsp)
Set a space in the sum.
See also
getSumSubspace
,petsc.PetscSpaceSumSetSubspace
- setTensorNumSubspaces(numTensSpaces)
Set the number of spaces in the tensor product.
See also
getTensorNumSubspaces
,petsc.PetscSpaceTensorSetNumSubspaces
- setTensorSubspace(s, subsp)
Set a space in the tensor product.
See also
getTensorSubspace
,petsc.PetscSpaceTensorSetSubspace
- setType(space_type)
Build a particular type of space.
Collective.
See also
getType
,petsc.PetscSpaceSetType
- setUp()
Construct data structures for the
Space
.Collective.
See also
petsc.PetscSpaceSetUp
Source code at petsc4py/PETSc/Space.pyx:22
- Return type:
- viewFromOptions(name, obj=None)
View a
Space
based on values in the options database.Collective.
- Parameters:
- Return type:
See also
Working with PETSc options (TODO),
petsc.PetscSpaceViewFromOptions