esys.escript.escriptcpp Package

Classes

class esys.escript.escriptcpp.ContinuousDomain

Bases: esys.escript.escriptcpp.Domain

Class representing continuous domains

MPIBarrier((Domain)arg1) → None :

Wait until all processes have reached this point

addPDEToRHS((ContinuousDomain)arg1, (Data)rhs, (Data)X, (Data)Y, (Data)y, (Data)y_contact, (Data)y_dirac) → None :

adds a PDE onto the stiffness matrix mat and a rhs

Parameters:
addPDEToSystem((ContinuousDomain)arg1, (Operator)mat, (Data)rhs, (Data)A, (Data)B, (Data)C, (Data)D, (Data)X, (Data)Y, (Data)d, (Data)y, (Data)d_contact, (Data)y_contact, (Data)d_dirac, (Data)y_dirac) → None :

adds a PDE onto the stiffness matrix mat and a rhs

Parameters:
addPDEToTransportProblem((ContinuousDomain)arg1, (TransportProblem)tp, (Data)source, (Data)M, (Data)A, (Data)B, (Data)C, (Data)D, (Data)X, (Data)Y, (Data)d, (Data)y, (Data)d_contact, (Data)y_contact, (Data)d_dirac, (Data)y_dirac) → None :
Parameters:
dump((Domain)arg1, (str)filename) → None :

Dumps the domain to a file:param filename: :type filename: string

getDataShape((ContinuousDomain)arg1, (int)functionSpaceCode) → object :
Returns:a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples
Return type:tuple
getDescription((ContinuousDomain)arg1) → str :
Returns:a description for this domain
Return type:string
getDim((Domain)arg1) → int :
Return type:int
Returns:Spatial dimension of the Domain
getMPIRank((Domain)arg1) → int :
Returns:the rank of this process
Return type:int
getMPISize((Domain)arg1) → int :
Returns:the number of processes used for this Domain
Return type:int
getNormal((Domain)arg1) → Data :
Return type:escript
Returns:Boundary normals
getNumDataPointsGlobal((ContinuousDomain)arg1) → int :
Returns:the number of data points summed across all MPI processes
Return type:int
getSize((Domain)arg1) → Data :
Returns:the local size of samples. The function space is chosen appropriately
Return type:Data
getStatus((Domain)arg1) → int :

The status of a domain changes whenever the domain is modified

Return type:int
getSystemMatrixTypeId((ContinuousDomain)arg1, (int)solver, (int)preconditioner, (int)package, (bool)symmetry) → int :
Returns:the identifier of the matrix type to be used for the global stiffness matrix when a particular solver package and symmetric matrix is used.
Return type:int
getTag((Domain)arg1, (str)name) → int :
Returns:tag id for name
Return type:string
getTransportTypeId((ContinuousDomain)arg1, (int)solver, (int)preconditioner, (int)package, (bool)symmetry) → int
getX((Domain)arg1) → Data :
Return type:Data
Returns:Locations in the`Domain`. FunctionSpace is chosen appropriately
isValidTagName((Domain)arg1, (str)name) → bool :
Returns:True is name corresponds to a tag
Return type:bool
newOperator((ContinuousDomain)arg1, (int)row_blocksize, (FunctionSpace)row_functionspace, (int)column_blocksize, (FunctionSpace)column_functionspace, (int)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((ContinuousDomain)theta, (int)blocksize, (FunctionSpace)functionspace, (int)type) → TransportProblem :

creates a TransportProblemAdapter

Parameters:
  • theta (float) –
  • blocksize (int) –
  • functionspace (FunctionSpace) –
  • type (int) –
onMasterProcessor((Domain)arg1) → bool :
Returns:True if this code is executing on the master process
Return type:bool
print_mesh_info((ContinuousDomain)arg1[, (bool)full=False]) → None :
Parameters:full (bool) –
setTagMap((Domain)arg1, (str)name, (int)tag) → None :

Give a tag number a name.

Parameters:
  • name (string) – Name for the tag
  • tag (int) – numeric id
Note :

Tag names must be unique within a domain

setX((ContinuousDomain)arg1, (Data)arg) → None :

assigns new location to the domain

Parameters:arg (Data) –
showTagNames((Domain)arg1) → str :
Returns:A space separated list of tag names
Return type:string
supportsContactElements((Domain)arg1) → bool :

Does this domain support contact elements.

class esys.escript.escriptcpp.Data

Bases: Boost.Python.instance

Represents a collection of datapoints. It is used to store the values of a function. For more details please consult the c++ class documentation.

copy((Data)arg1, (Data)other) → None :

Make this object a copy of other

note:The two objects will act independently from now on. That is, changing other after this call will not change this object and vice versa.
copy( (Data)arg1) -> Data :
note:In the no argument form, a new object will be returned which is an independent copy of this object.
copyWithMask((Data)arg1, (Data)other, (Data)mask) → None :

Selectively copy values from other Data.Datapoints which correspond to positive values in mask will be copied from other

Parameters:
  • other (Data) – source of values
  • mask (Scalar Data) –
delay((Data)arg1) → Data :

Convert this object into lazy representation

dump((Data)arg1, (str)fileName) → None :

Save the data as a netCDF file

Parameters:fileName (string) –
expand((Data)arg1) → None :

Convert the data to expanded representation if it is not expanded already.

getDomain((Data)arg1) → Domain :
Return type:Domain
getFunctionSpace((Data)arg1) → FunctionSpace :
Return type:FunctionSpace
getNumberOfDataPoints((Data)arg1) → int :
Return type:int
Returns:Number of datapoints in the object
getRank((Data)arg1) → int :
Returns:the number of indices required to address a component of a datapoint
Return type:positive int
getShape((Data)arg1) → tuple :

Returns the shape of the datapoints in this object as a python tuple. Scalar data has the shape ()

Return type:tuple
getTagNumber((Data)arg1, (int)dpno) → int :

Return tag number for the specified datapoint

Return type:int
Parameters:dpno (int) – datapoint number
getTupleForDataPoint((Data)arg1, (int)dataPointNo) → object :
Returns:Value of the specified datapoint
Return type:tuple
Parameters:dataPointNo (int) – datapoint to access
getTupleForGlobalDataPoint((Data)arg1, (int)procNo, (int)dataPointNo) → object :

Get a specific datapoint from a specific process

Return type:

tuple

Parameters:
  • procNo (positive int) – MPI rank of the process
  • dataPointNo (int) – datapoint to access
interpolate((Data)arg1, (FunctionSpace)functionspace) → Data :

Interpolate this object’s values into a new functionspace.

interpolateTable((Data)arg1, (object)table, (float)Amin, (float)Astep, (Data)B, (float)Bmin, (float)Bstep[, (float)undef=1e+50[, (bool)check_boundaries=False]]) → Data :

Creates a new Data object by interpolating using the source data (which are looked up in table) A must be the outer dimension on the table

param table:two dimensional collection of values
param Amin:The base of locations in table
type Amin:float
param Astep:size of gap between each item in the table
type Astep:float
param undef:upper bound on interpolated values
type undef:float
param B:Scalar representing the second coordinate to be mapped into the table
type B:Data
param Bmin:The base of locations in table for 2nd dimension
type Bmin:float
param Bstep:size of gap between each item in the table for 2nd dimension
type Bstep:float
param check_boundaries:
 if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.
raise RuntimeError(DataException):
 if the coordinates do not map into the table or if the interpolated value is above undef
rtype:Data

interpolateTable( (Data)arg1, (object)table, (float)Amin, (float)Astep [, (float)undef=1e+50 [, (bool)check_boundaries=False]]) -> Data

isConstant((Data)arg1) → bool :
Return type:bool
Returns:True if this Data is an instance of DataConstant
Note :This does not mean the data is immutable.
isEmpty((Data)arg1) → bool :

Is this object an instance of DataEmpty

Return type:bool
Note :This is not the same thing as asking if the object contains datapoints.
isExpanded((Data)arg1) → bool :
Return type:bool
Returns:True if this Data is expanded.
isLazy((Data)arg1) → bool :
Return type:bool
Returns:True if this Data is lazy.
isProtected((Data)arg1) → bool :

Can this instance be modified. :rtype: bool

isReady((Data)arg1) → bool :
Return type:bool
Returns:True if this Data is not lazy.
isTagged((Data)arg1) → bool :
Return type:bool
Returns:True if this Data is expanded.
maxGlobalDataPoint((Data)arg1) → tuple :

Please consider using getSupLocator() from pdetools instead.

minGlobalDataPoint((Data)arg1) → tuple :

Please consider using getInfLocator() from pdetools instead.

nonuniformInterpolate((Data)arg1, (object)in, (object)out, (bool)check_boundaries) → Data :

1D interpolation with non equally spaced points

nonuniformSlope((Data)arg1, (object)in, (object)out, (bool)check_boundaries) → Data :

1D interpolation of slope with non equally spaced points

resolve((Data)arg1) → None :

Convert the data to non-lazy representation.

setProtection((Data)arg1) → None :

Disallow modifications to this data object

Note :This method does not allow you to undo protection.
setTaggedValue((Data)arg1, (int)tagKey, (object)value) → None :

Set the value of tagged Data.

param tagKey:tag to update
type tagKey:int
setTaggedValue( (Data)arg1, (str)name, (object)value) -> None :
param name:tag to update
type name:string
param value:value to set tagged data to
type value:object which acts like an array, tuple or list
setToZero((Data)arg1) → None :

After this call the object will store values of the same shape as before but all components will be zero.

setValueOfDataPoint((Data)arg1, (int)dataPointNo, (object)value) → None

setValueOfDataPoint( (Data)arg1, (int)arg2, (object)arg3) -> None

setValueOfDataPoint( (Data)arg1, (int)arg2, (float)arg3) -> None :

Modify the value of a single datapoint.

param dataPointNo:
 
type dataPointNo:
 int
param value:
type value:float or an object which acts like an array, tuple or list
warning:Use of this operation is discouraged. It prevents some optimisations from operating.
tag((Data)arg1) → None :

Convert data to tagged representation if it is not already tagged or expanded

toListOfTuples((Data)arg1[, (bool)scalarastuple=False]) → object :

Return the datapoints of this object in a list. Each datapoint is stored as a tuple.

Parameters:scalarastuple – if True, scalar data will be wrapped as a tuple. True => [(0), (1), (2)]; False => [0, 1, 2]
class esys.escript.escriptcpp.Domain

Bases: Boost.Python.instance

Base class for all domains.

MPIBarrier((Domain)arg1) → None :

Wait until all processes have reached this point

dump((Domain)arg1, (str)filename) → None :

Dumps the domain to a file:param filename: :type filename: string

getDim((Domain)arg1) → int :
Return type:int
Returns:Spatial dimension of the Domain
getMPIRank((Domain)arg1) → int :
Returns:the rank of this process
Return type:int
getMPISize((Domain)arg1) → int :
Returns:the number of processes used for this Domain
Return type:int
getNormal((Domain)arg1) → Data :
Return type:escript
Returns:Boundary normals
getSize((Domain)arg1) → Data :
Returns:the local size of samples. The function space is chosen appropriately
Return type:Data
getStatus((Domain)arg1) → int :

The status of a domain changes whenever the domain is modified

Return type:int
getTag((Domain)arg1, (str)name) → int :
Returns:tag id for name
Return type:string
getX((Domain)arg1) → Data :
Return type:Data
Returns:Locations in the`Domain`. FunctionSpace is chosen appropriately
isValidTagName((Domain)arg1, (str)name) → bool :
Returns:True is name corresponds to a tag
Return type:bool
onMasterProcessor((Domain)arg1) → bool :
Returns:True if this code is executing on the master process
Return type:bool
setTagMap((Domain)arg1, (str)name, (int)tag) → None :

Give a tag number a name.

Parameters:
  • name (string) – Name for the tag
  • tag (int) – numeric id
Note :

Tag names must be unique within a domain

showTagNames((Domain)arg1) → str :
Returns:A space separated list of tag names
Return type:string
supportsContactElements((Domain)arg1) → bool :

Does this domain support contact elements.

class esys.escript.escriptcpp.FunctionSpace

Bases: Boost.Python.instance

A FunctionSpace describes which points from the Domain to use to represent functions.

getApproximationOrder((FunctionSpace)arg1) → int :
Returns:the approximation order referring to the maximum degree of a polynomial which can be represented exactly in interpolation and/or integration.
Return type:int
getDim((FunctionSpace)arg1) → int :
Returns:the spatial dimension of the underlying domain.
Return type:int
getDomain((FunctionSpace)arg1) → Domain :
Returns:the underlying Domain for this FunctionSpace.
Return type:Domain
getListOfTags((FunctionSpace)arg1) → list :
Returns:a list of the tags used in this function space
Return type:list
getNormal((FunctionSpace)arg1) → Data :
Returns:the surface normal field.
Return type:Data
getReferenceIDFromDataPointNo((FunctionSpace)arg1, (int)dataPointNo) → int :
Returns:the reference number associated with dataPointNo
Return type:int
getSize((FunctionSpace)arg1) → Data :
Returns:sample size
Return type:Data
getTagFromDataPointNo((FunctionSpace)arg1, (int)arg2) → int :
Returns:the tag associated with the given sample number.
Return type:int
getX((FunctionSpace)arg1) → Data :
Returns:a function whose values are its input coordinates. ie an identity function.
Return type:Data
setTags((FunctionSpace)arg1, (int)newtag, (Data)mask) → None :

Set tags according to a mask

param newtag:tag number to set
type newtag:string, non-zero int
param mask:Samples which correspond to positive values in the mask will be set to newtag.
type mask:scalar Data

setTags( (FunctionSpace)arg1, (str)newtag, (Data)mask) -> None

class esys.escript.escriptcpp.Operator

Bases: Boost.Python.instance

isEmpty((Operator)arg1) → int :
Return type:bool
Returns:True if matrix is empty
nullifyRowsAndCols((Operator)arg1, (Data)arg2, (Data)arg3, (float)arg4) → None
of((Operator)arg1, (Data)right) → Data :

matrix*vector multiplication

resetValues((Operator)arg1) → None :

resets the matrix entries

saveHB((Operator)arg1, (str)filename) → None :

writes the matrix to a file using the Harwell-Boeing file format

saveMM((Operator)arg1, (str)fileName) → None :

writes the matrix to a file using the Matrix Market file format

solve((Operator)arg1, (Data)in, (object)options) → Data :
Returns:the solution u of the linear system this*u=in
Parameters:in (Data) –
class esys.escript.escriptcpp.TestDomain

Bases: esys.escript.escriptcpp.Domain

Test Class for domains with no structure. May be removed from future releases without notice.

MPIBarrier((Domain)arg1) → None :

Wait until all processes have reached this point

dump((Domain)arg1, (str)filename) → None :

Dumps the domain to a file:param filename: :type filename: string

getDim((Domain)arg1) → int :
Return type:int
Returns:Spatial dimension of the Domain
getMPIRank((Domain)arg1) → int :
Returns:the rank of this process
Return type:int
getMPISize((Domain)arg1) → int :
Returns:the number of processes used for this Domain
Return type:int
getNormal((Domain)arg1) → Data :
Return type:escript
Returns:Boundary normals
getSize((Domain)arg1) → Data :
Returns:the local size of samples. The function space is chosen appropriately
Return type:Data
getStatus((Domain)arg1) → int :

The status of a domain changes whenever the domain is modified

Return type:int
getTag((Domain)arg1, (str)name) → int :
Returns:tag id for name
Return type:string
getX((Domain)arg1) → Data :
Return type:Data
Returns:Locations in the`Domain`. FunctionSpace is chosen appropriately
isValidTagName((Domain)arg1, (str)name) → bool :
Returns:True is name corresponds to a tag
Return type:bool
onMasterProcessor((Domain)arg1) → bool :
Returns:True if this code is executing on the master process
Return type:bool
setTagMap((Domain)arg1, (str)name, (int)tag) → None :

Give a tag number a name.

Parameters:
  • name (string) – Name for the tag
  • tag (int) – numeric id
Note :

Tag names must be unique within a domain

showTagNames((Domain)arg1) → str :
Returns:A space separated list of tag names
Return type:string
supportsContactElements((Domain)arg1) → bool :

Does this domain support contact elements.

class esys.escript.escriptcpp.TransportProblem

Bases: Boost.Python.instance

getSafeTimeStepSize((TransportProblem)arg1) → float
getUnlimitedTimeStepSize((TransportProblem)arg1) → float
insertConstraint((TransportProblem)source, (Data)q, (Data)r, (Data)factor) → None :

inserts constraint u_{,t}=r where q>0 into the problem using a weighting factor

isEmpty((TransportProblem)arg1) → int :
Return type:int
reset((TransportProblem)arg1) → None :

resets the transport operator typically as they have been updated.

resetValues((TransportProblem)arg1) → None
solve((TransportProblem)arg1, (Data)u0, (Data)source, (float)dt, (object)options) → Data :

returns the solution u for a time step dt>0 with initial value u0

Return type:Data
Parameters:source (Data) –

Functions

esys.escript.escriptcpp.C_GeneralTensorProduct((Data)arg0, (Data)arg1[, (int)axis_offset=0[, (int)transpose=0]]) → Data :

Compute a tensor product of two Data objects.

Return type:

Data

Parameters:
  • arg0
  • arg1
  • axis_offset (int) –
  • transpose (int) – 0: transpose neither, 1: transpose arg0, 2: transpose arg1
esys.escript.escriptcpp.ContinuousFunction((Domain)domain) → FunctionSpace :
Returns:a continuous FunctionSpace (overlapped node values)
Return type:FunctionSpace
esys.escript.escriptcpp.DiracDeltaFunctions((Domain)domain) → FunctionSpace :
Return type:FunctionSpace
esys.escript.escriptcpp.Function((Domain)domain) → FunctionSpace :
Returns:a function FunctionSpace
Return type:FunctionSpace
esys.escript.escriptcpp.FunctionOnBoundary((Domain)domain) → FunctionSpace :
Returns:a function on boundary FunctionSpace
Return type:FunctionSpace
esys.escript.escriptcpp.FunctionOnContactOne((Domain)domain) → FunctionSpace :
Returns:Return a FunctionSpace on right side of contact
Return type:FunctionSpace
esys.escript.escriptcpp.FunctionOnContactZero((Domain)domain) → FunctionSpace :
Returns:Return a FunctionSpace on left side of contact
Return type:FunctionSpace
esys.escript.escriptcpp.MPIBarrierWorld() → None :

Wait until all MPI processes have reached this point.

esys.escript.escriptcpp.RandomData((tuple)shape, (FunctionSpace)fs[, (int)seed=0]) → Data :

Creates a new expanded Data object containing (not very) random values.

Parameters:
  • shape (tuple) – datapoint shape
  • fs (FunctionSpace) – function space for data object.
  • seed (long) – seed for random number generator.
esys.escript.escriptcpp.ReducedContinuousFunction((Domain)domain) → FunctionSpace :
Returns:a continuous with reduced order FunctionSpace (overlapped node values on reduced element order)
Return type:FunctionSpace
esys.escript.escriptcpp.ReducedFunction((Domain)domain) → FunctionSpace :
Returns:a function FunctionSpace with reduced integration order
Return type:FunctionSpace
esys.escript.escriptcpp.ReducedFunctionOnBoundary((Domain)domain) → FunctionSpace :
Returns:a function on boundary FunctionSpace with reduced integration order
Return type:FunctionSpace
esys.escript.escriptcpp.ReducedFunctionOnContactOne((Domain)domain) → FunctionSpace :
Returns:Return a FunctionSpace on right side of contact with reduced integration order
Return type:FunctionSpace
esys.escript.escriptcpp.ReducedFunctionOnContactZero((Domain)domain) → FunctionSpace :
Returns:a FunctionSpace on left side of contact with reduced integration order
Return type:FunctionSpace
esys.escript.escriptcpp.ReducedSolution((Domain)domain) → FunctionSpace :
Return type:FunctionSpace
esys.escript.escriptcpp.Scalar([(float)value=0.0[, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ebd0>[, (bool)expanded=False]]]) → Data :

Construct a Data object containing scalar data-points.

Parameters:
  • value (float) – scalar value for all points
  • what (FunctionSpace) – FunctionSpace for Data
  • expanded (bool) – If True, a value is stored for each point. If False, more efficient representations may be used
Return type:

Data

esys.escript.escriptcpp.Solution((Domain)domain) → FunctionSpace :
Return type:FunctionSpace
esys.escript.escriptcpp.Tensor([(float)value=0.0[, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ed50>[, (bool)expanded=False]]]) → Data :

Construct a Data object containing rank2 data-points.

param value:scalar value for all points
rtype:Data
type value:float
param what:FunctionSpace for Data
type what:FunctionSpace
param expanded:If True, a value is stored for each point. If False, more efficient representations may be used
type expanded:bool

Tensor( (object)value [, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413edd0> [, (bool)expanded=False]]) -> Data

esys.escript.escriptcpp.Tensor3([(float)value=0.0[, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ee50>[, (bool)expanded=False]]]) → Data :

Construct a Data object containing rank3 data-points.

param value:scalar value for all points
rtype:Data
type value:float
param what:FunctionSpace for Data
type what:FunctionSpace
param expanded:If True, a value is stored for each point. If False, more efficient representations may be used
type expanded:bool

Tensor3( (object)value [, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413eed0> [, (bool)expanded=False]]) -> Data

esys.escript.escriptcpp.Tensor4([(float)value=0.0[, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ef50>[, (bool)expanded=False]]]) → Data :

Construct a Data object containing rank4 data-points.

param value:scalar value for all points
rtype:Data
type value:float
param what:FunctionSpace for Data
type what:FunctionSpace
param expanded:If True, a value is stored for each point. If False, more efficient representations may be used
type expanded:bool

Tensor4( (object)value [, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x4150050> [, (bool)expanded=False]]) -> Data

esys.escript.escriptcpp.Vector([(float)value=0.0[, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ec50>[, (bool)expanded=False]]]) → Data :

Construct a Data object containing rank1 data-points.

param value:scalar value for all points
rtype:Data
type value:float
param what:FunctionSpace for Data
type what:FunctionSpace
param expanded:If True, a value is stored for each point. If False, more efficient representations may be used
type expanded:bool

Vector( (object)value [, (FunctionSpace)what=<esys.escript.escriptcpp.FunctionSpace object at 0x413ecd0> [, (bool)expanded=False]]) -> Data

esys.escript.escriptcpp._condEval((Data)mask, (Data)trueval, (Data)falseval) → Data
esys.escript.escriptcpp._saveDataCSV((str)filename, (dict)arg, (str)sep, (str)csep[, (bool)append=False]) → None :

Saves data objects passed in a python dictionary to a file. The data objects must be over the same domain and be able to be interpolated to the same FunctionSpace. If one of the dictionary keys is named mask, then only samples where mask has a positive value will be written to the file.

A header line giving the names of each column will be output first. The keys given in the dictionary will be used to name columns. Then the data will be output, one line per sample (for all data). That is, items in each column will be printed in the same order. So you can be sure that values in the same row correspond to the same input value.

Parameters:
  • filename (string) –
  • arg (dict) – dictionary of named Data objects. If one is called mask it must be scalar data.
  • sep (string) – separator for columns (defaults to ‘,’)
  • csep (string) – separator for fields within data object (defaults to “_”)
  • append (string) – If True, write to the end of filename
esys.escript.escriptcpp.blocktimer_increment((str)arg1, (float)arg2) → None
esys.escript.escriptcpp.blocktimer_initialize() → None
esys.escript.escriptcpp.blocktimer_reportSortByName() → None
esys.escript.escriptcpp.blocktimer_reportSortByTime() → None
esys.escript.escriptcpp.blocktimer_time() → float
esys.escript.escriptcpp.canInterpolate((FunctionSpace)src, (FunctionSpace)dest) → bool :
Parameters:
  • src – Source FunctionSpace
  • dest – Destination FunctionSpace
Returns:

True if src can be interpolated to dest

Return type:

bool

esys.escript.escriptcpp.getEscriptParamInt((str)name[, (int)sentinel=0]) → int :

Read the value of an escript tuning parameter

Parameters:
  • name (string) – parameter to lookup
  • sentinel (int) – Value to be returned if name is not a known parameter
esys.escript.escriptcpp.getMPIRankWorld() → int :

Return the rank of this process in the MPI World.

esys.escript.escriptcpp.getMPISizeWorld() → int :

Return number of MPI processes in the job.

esys.escript.escriptcpp.getMPIWorldMax((int)arg1) → int :

Each MPI process calls this function with a value for arg1. The maximum value is computed and returned.

Return type:int
esys.escript.escriptcpp.getMPIWorldSum((int)arg1) → int :

Each MPI process calls this function with a value for arg1. The values are added up and the total value is returned.

Return type:int
esys.escript.escriptcpp.getMachinePrecision() → float
esys.escript.escriptcpp.getMaxFloat() → float
esys.escript.escriptcpp.getNumberOfThreads() → int :

Return the maximum number of threads available to OpenMP.

esys.escript.escriptcpp.getTestDomainFunctionSpace((int)dpps, (int)samples[, (int)size=1]) → FunctionSpace :

For testing only. May be removed without notice.

esys.escript.escriptcpp.getVersion() → int :

This method will only report accurate version numbers for clean checkouts.

esys.escript.escriptcpp.listEscriptParams() → list :
Returns:A list of pairs (p,d) where p is the name of a parameter for escript and d is a description.
esys.escript.escriptcpp.load((str)fileName, (Domain)domain) → Data :

reads Data on domain from file in netCDF format

Parameters:
  • fileName (string) –
  • domain (Domain) –
esys.escript.escriptcpp.loadIsConfigured() → bool :
Returns:True if the load function is configured.
esys.escript.escriptcpp.printParallelThreadCounts() → None
esys.escript.escriptcpp.releaseUnusedMemory() → None
esys.escript.escriptcpp.resolveGroup((object)arg1) → None
esys.escript.escriptcpp.runMPIProgram((list)arg1) → int :

Spawns an external MPI program using a separate communicator.

esys.escript.escriptcpp.setEscriptParamInt((str)name[, (int)value=0]) → None :

Modify the value of an escript tuning parameter

Parameters:
  • name (string) –
  • value (int) –
esys.escript.escriptcpp.setNumberOfThreads((int)arg1) → None :

Use of this method is strongly discouraged.

Others

  • __doc__
  • __file__
  • __name__
  • __package__