esys.ripley Package¶
A domain meshed with uniform rectangles or quadrilaterals
Classes¶
-
class
esys.ripley.
AbstractAssembler
¶ -
__init__
()¶ Raises an exception This class cannot be instantiated from Python
-
-
class
esys.ripley.
MultiResolutionDomain
(dim, **kwargs)¶ Constructs domains of varying resolutions that are guaranteed to be compatible for cross-domain interpolation. The parameters supplied will be used to construct the coarsest resolution. No coarser domain can be constructed.
Each domain of finer resolution will have the number of elements in every axis of the coarsest domain multiplied by
2**n
, wheren
is the level of subdivision.-
__init__
(dim, **kwargs)¶ - Parameters
dim (
int
) – the spatial dimension of the domain to createkwargs – the arguments normally passed to a constructor of Rectangle or Brick, including as the number of elements
n0=...
,n1=...
, etc.
-
getLevel
(level)¶ Returns a domain with each element subdivided
level
times- Parameters
level (
int
) – the number of times to subdivide each element
-
getMaxDepth
()¶ Returns the level of the finest domain created so far
-
-
class
esys.ripley.
RipleyBrick
¶ -
__init__
()¶ Raises an exception This class cannot be instantiated from Python
-
-
class
esys.ripley.
RipleyDomain
¶ -
__init__
()¶ Raises an exception This class cannot be instantiated from Python
-
MPIBarrier
((RipleyDomain)arg1) → None :¶ Wait until all processes have reached this point
-
addPDEToTransportProblem
((RipleyDomain)arg1, (TransportProblem)arg2, (Data)tp, (list)source, (AbstractAssembler)data) → None :¶ - Parameters
tp (
TransportProblemAdapter
) –source (
Data
) –data (
list
) –
-
addToRHS
((RipleyDomain)arg1, (Data)arg2, (list)rhs, (AbstractAssembler)data) → None :¶ adds a PDE onto the stiffness matrix mat and a rhs, results depends on domain
- Parameters
rhs (
Data
) –data (
list
) –
-
addToSystem
((RipleyDomain)arg1, (Operator)arg2, (Data)mat, (list)rhs, (AbstractAssembler)data) → None :¶ adds a PDE to the system, results depend on domain
- Parameters
mat (
OperatorAdapter
) –rhs (
Data
) –data (
list
) –
-
createAssembler
((RipleyDomain)arg1, (str)typename, (list)options) → AbstractAssembler :¶ request from the domain an assembler of the specified type, if supported, using the supplied options (if provided):param typename: :type typename:
string
:param options: :type options:list
-
dump
((RipleyDomain)arg1, (str)filename) → None :¶ Dumps the mesh to a file with the given name.
-
getDataShape
((RipleyDomain)arg1, (object)functionSpaceCode) → object :¶ - Returns
a pair (dps, ns) where dps is the number of data points per sample, and ns is the number of samples
- Return type
tuple
-
getDescription
((RipleyDomain)arg1) → str :¶ - Returns
a description for this domain
- Return type
string
-
getDim
((RipleyDomain)arg1) → int :¶ - Return type
int
-
getGridParameters
((RipleyDomain)arg1) → tuple :¶ - Returns the tuple (origin, spacing, elements) where the entries are tuples containing
origin
the coordinates of the domain’s global origin,spacing
the element size (node spacing) of the domain,elements
the global number of elements in all dimensions
- Return type
tuple
-
getMPIRank
((RipleyDomain)arg1) → int :¶ - Returns
the rank of this process
- Return type
int
-
getMPISize
((RipleyDomain)arg1) → int :¶ - Returns
the number of processes used for this
Domain
- Return type
int
-
getNormal
((RipleyDomain)arg1) → Data :¶ - Returns
boundary normals at the quadrature point on the face elements
- Return type
Data
-
getNumDataPointsGlobal
((RipleyDomain)arg1) → int :¶ - Returns
the number of data points summed across all MPI processes
- Return type
int
-
getSize
((RipleyDomain)arg1) → Data :¶ - Returns
the element size
- Return type
Data
-
getSystemMatrixTypeId
((RipleyDomain)arg1, (object)options) → int :¶ - Returns
the identifier of the matrix type to be used for the global stiffness matrix when particular solver options are used.
- Return type
int
- Parameters
options (
SolverBuddy
) –
-
getTag
((RipleyDomain)arg1, (str)name) → int :¶ - Returns
tag id for
name
- Return type
string
-
getTransportTypeId
((RipleyDomain)arg1, (object)solver, (object)preconditioner, (object)package, (object)symmetry) → int :¶ - Returns
the identifier of the transport problem type to be used when a particular solver, preconditioner, package and symmetric matrix is used.
- Return type
int
- Parameters
solver (
int
) –preconditioner (
int
) –package (
int
) –symmetry (
int
) –
-
getX
((RipleyDomain)arg1) → Data :¶ - Returns
locations in the FEM nodes
- Return type
Data
-
isValidTagName
((RipleyDomain)arg1, (str)name) → bool :¶ - Returns
True if
name
corresponds to a tag, otherwise False- Return type
bool
-
newOperator
((RipleyDomain)arg1, (object)row_blocksize, (FunctionSpace)row_functionspace, (object)column_blocksize, (FunctionSpace)column_functionspace, (object)type) → Operator :¶ creates a SystemMatrixAdapter stiffness matrix and initializes it with zeros
- Parameters
row_blocksize (
int
) –row_functionspace (
FunctionSpace
) –column_blocksize (
int
) –column_functionspace (
FunctionSpace
) –type (
int
) –
-
newTransportProblem
((RipleyDomain)theta, (object)blocksize, (FunctionSpace)functionspace, (object)type) → TransportProblem :¶ creates a TransportProblemAdapter
- Parameters
theta (
float
) –blocksize (
int
) –functionspace (
FunctionSpace
) –type (
int
) –
-
onMasterProcessor
((RipleyDomain)arg1) → bool :¶ - Returns
True if this code is executing on the master process
- Return type
bool
-
print_mesh_info
((RipleyDomain)arg1[, (object)full=False]) → None :¶ Prints out a summary about the mesh. :param full: whether to output additional data :type full:
bool
-
setTagMap
((RipleyDomain)arg1, (str)name, (object)tag) → None :¶ Give a tag number a name.
- Parameters
name (
string
) – Name for the tagtag (
int
) – numeric id
- Note
Tag names must be unique within a domain
-
showTagNames
((RipleyDomain)arg1) → str :¶ - Returns
A space separated list of tag names
- Return type
string
-
writeBinaryGrid
((RipleyDomain)arg1, (Data)arg2, (str)arg3, (object)arg4, (object)arg5) → None¶
-
-
class
esys.ripley.
RipleyMultiBrick
¶ -
__init__
()¶ Raises an exception This class cannot be instantiated from Python
-
Functions¶
-
esys.ripley.
Brick
((object)n0, (object)n1, (object)n2[, (object)l0=1.0[, (object)l1=1.0[, (object)l2=1.0[, (object)d0=-1[, (object)d1=-1[, (object)d2=-1[, (object)diracPoints=[][, (object)diracTags=[][, (SubWorld)escriptworld=None]]]]]]]]]) → Domain :¶ Creates a hexagonal mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].
- Parameters
n0 (
int
) – number of elements in direction 0n1 (
int
) – number of elements in direction 1n2 (
int
) – number of elements in direction 2l0 (
float
ortuple
) – length of side 0 or coordinate range of side 0l1 (
float
ortuple
) – length of side 1 or coordinate range of side 1l2 (
float
ortuple
) – length of side 2 or coordinate range of side 2d0 (
int
) – number of subdivisions in direction 0d1 (
int
) – number of subdivisions in direction 1d2 (
int
) – number of subdivisions in direction 2
-
esys.ripley.
MultiBrick
((object)n0, (object)n1, (object)n2[, (object)l0=1.0[, (object)l1=1.0[, (object)l2=1.0[, (object)d0=-1[, (object)d1=-1[, (object)d2=-1[, (object)diracPoints=[][, (object)diracTags=[][, (SubWorld)escriptworld=None[, (object)multiplier=1]]]]]]]]]]) → Domain :¶ Creates a hexagonal mesh with n0 x n1 x n2 parent elements over the brick [0,l0] x [0,l1] x [0,l2], each parent element is divided
multiplier
times.- Parameters
n0 (
int
) – number of elements in direction 0n1 (
int
) – number of elements in direction 1n2 (
int
) – number of elements in direction 2l0 (
float
ortuple
) – length of side 0 or coordinate range of side 0l1 (
float
ortuple
) – length of side 1 or coordinate range of side 1l2 (
float
ortuple
) – length of side 2 or coordinate range of side 2d0 (
int
) – number of subdivisions in direction 0d1 (
int
) – number of subdivisions in direction 1d2 (
int
:param multiplier: size of overlap) – number of subdivisions in direction 2
-
esys.ripley.
MultiRectangle
((object)n0, (object)n1[, (object)l0=1.0[, (object)l1=1.0[, (object)d0=-1[, (object)d1=-1[, (object)diracPoints=[][, (object)diracTags=[][, (SubWorld)escriptworld=None[, (object)multiplier=1]]]]]]]]) → Domain :¶ Creates a rectangular mesh with n0 x n1 parent elements over the rectangle [0,l0] x [0,l1], each parent element is divided
multiplier
times.- Parameters
n0 (
int
) – number of elements in direction 0n1 (
int
) – number of elements in direction 1l0 (
float
ortuple
) – length of side 0 or coordinate range of side 0l1 (
float
ortuple
) – length of side 1 or coordinate range of side 1d0 (
int
) – number of subdivisions in direction 0d1 (
int
) – number of subdivisions in direction 1multiplier (
unsigned int
) – size of overlap
-
esys.ripley.
Rectangle
((object)n0, (object)n1[, (object)l0=1.0[, (object)l1=1.0[, (object)d0=-1[, (object)d1=-1[, (object)diracPoints=[][, (object)diracTags=[][, (SubWorld)escriptworld=None]]]]]]]) → Domain :¶ Creates a rectangular mesh with n0 x n1 elements over the rectangle [0,l0] x [0,l1].
- Parameters
n0 (
int
) – number of elements in direction 0n1 (
int
) – number of elements in direction 1l0 (
float
ortuple
) – length of side 0 or coordinate range of side 0l1 (
float
ortuple
) – length of side 1 or coordinate range of side 1d0 (
int
) – number of subdivisions in direction 0d1 (
int
) – number of subdivisions in direction 1
-
esys.ripley.
readBinaryGrid
((str)filename, (FunctionSpace)functionspace, (object)shape, (object)fill=0.0, (object)byteOrder, (object)dataType, (object)first, (object)numValues, (object)multiplier, (object)reverse) → Data :¶ Reads a binary Grid
-
esys.ripley.
setDecompositionPolicy
((object)value) → None :¶ Sets the automatic domain decomposition policy for new domains.
- Parameters
value (
int
) – policy
Others¶
BYTEORDER_BIG_ENDIAN
BYTEORDER_LITTLE_ENDIAN
BYTEORDER_NATIVE
DATATYPE_FLOAT32
DATATYPE_FLOAT64
DATATYPE_INT32
DECOMP_ADD_ELEMENTS
DECOMP_EXPAND
DECOMP_STRICT