Namespaces | Classes | Typedefs | Enumerations | Functions | Variables

escript Namespace Reference

Namespaces

namespace  DataMaths
 

Contains maths operations performed on data vectors.


namespace  DataTypes
 

Contains the types to represent Shapes, Regions, RegionLoop ranges and vectors of data as well as the functions to manipulate them.


Classes

class  AbstractContinuousDomain
 AbstractContinuousDomain, base class for continuous domains. More...
class  AbstractDomain
class  AbstractSystemMatrix
 Give a short description of what AbstractSystemMatrix does. More...
class  AbstractTransportProblem
 Give a short description of what AbstractTransportProblem does. More...
class  Data
 Data represents a collection of datapoints. More...
class  DataAbstract
class  DataAlgorithmAdapter
 Adapt binary algorithms so they may be used in DataArrayView reduction operations. More...
struct  FMax
 Return the maximum value of the two given values. More...
struct  FMin
 Return the minimum value of the two given values. More...
struct  AbsMax
 Return the absolute maximum value of the two given values. More...
struct  AbsMin
 Return the absolute minimum value of the two given values. More...
struct  Length
 Return the length between the two given values. More...
struct  Trace
 Return the trace of the two given values. More...
struct  AbsGT
 Return 1 if abs(x)>y, otherwise return 0. More...
struct  AbsLTE
 Return 1 if abs(x)<=y, otherwise return 0. More...
class  DataBlocks2D
 DataBlocks2D manages a 2D array of multi-dimensional data points. More...
class  DataConstant
 DataConstant stores a single data point which represents the entire function space. More...
class  DataEmpty
 Implements the DataAbstract interface for an empty Data object. More...
class  DataException
 DataException exception class. More...
class  DataExpanded
 Give a short description of what DataExpanded does. More...
class  DataLazy
 Wraps an expression tree of other DataObjects. The data will be evaluated when required. More...
class  DataReady
class  DataTagged
 Simulates a full dataset accessible via sampleNo and dataPointNo. More...
class  DataVector
 DataVector implements an arbitrarily long vector of data values. DataVector is the underlying data container for Data objects. More...
class  DomainException
 DomainException exception class. More...
class  EscriptParams
class  FunctionSpace
 Give a short description of what FunctionSpace does. More...
class  FunctionSpaceException
 FunctionSpaceException exception class. More...
class  LapackInverseHelper
class  NullDomain
 NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace. More...
class  SystemMatrixException
 SystemMatrixException exception class. More...
class  Taipan
 Taipan array manager, C++ version. Based on TaipanMemManager C module by Lutz Gross. More...
class  TestDomain
 (Testing use only) Provides a domain to wrap a collection of values. More...
class  TransportProblemException
 TransportProblemException exception class. More...
class  WrappedArray

Typedefs

typedef boost::shared_ptr
< AbstractDomain > 		Domain_ptr
typedef boost::shared_ptr
< const AbstractDomain > 		const_Domain_ptr
typedef boost::shared_ptr
< AbstractSystemMatrix > 		ASM_ptr
typedef boost::shared_ptr
< AbstractTransportProblem > 		ATP_ptr
typedef boost::shared_ptr
< DataAbstract > 		DataAbstract_ptr
typedef boost::shared_ptr
< const DataAbstract > 		const_DataAbstract_ptr
typedef boost::shared_ptr
< DataReady > 		DataReady_ptr
typedef boost::shared_ptr
< const DataReady > 		const_DataReady_ptr
typedef boost::shared_ptr
< DataLazy > 		DataLazy_ptr
typedef boost::shared_ptr
< const DataLazy > 		const_DataLazy_ptr
typedef int(* binOpFnPtr )(double *, const double *, const double *, int, int, int)

Enumerations

enum  ES_optype {
  UNKNOWNOP = 0, IDENTITY = 1, ADD = 2, SUB = 3,
  MUL = 4, DIV = 5, POW = 6, SIN = POW+1,
  COS = SIN+1, TAN = SIN+2, ASIN = SIN+3, ACOS = SIN+4,
  ATAN = SIN+5, SINH = SIN+6, COSH = SIN+7, TANH = SIN+8,
  ERF = SIN+9, ASINH = SIN+10, ACOSH = SIN+11, ATANH = SIN+12,
  LOG10 = ATANH+1, LOG = LOG10+1, SIGN = LOG10+2, ABS = LOG10+3,
  NEG = LOG10+4, POS = LOG10+5, EXP = LOG10+6, SQRT = LOG10+7,
  RECIP = LOG10+8, GZ = RECIP+1, LZ = GZ+1, GEZ = GZ+2,
  LEZ = GZ+3, NEZ = GZ+4, EZ = GZ+5, SYM = EZ+1,
  NSYM = SYM+1, PROD = NSYM+1, TRANS = PROD+1, TRACE = TRANS+1,
  SWAP = TRACE+1, MINVAL = SWAP+1, MAXVAL = MINVAL+1, CONDEVAL = MAXVAL+1
}

Functions

Data operator* (const AbstractSystemMatrix &left, const Data &right)
template<class BinaryFunction >
void binaryOp (DataTagged &left, const DataConstant &right, BinaryFunction operation)
 Perform the given binary operation.
template<class BinaryFunction >
void binaryOp (DataTagged &left, const DataTypes::ValueType &right, const DataTypes::ShapeType &shape, BinaryFunction operation)
 apply the binary op to each value in left and the single value right.
template<class BinaryFunction >
void binaryOp (DataTagged &left, const DataTagged &right, BinaryFunction operation)
template<class BinaryFunction >
void binaryOp (DataConstant &left, const DataConstant &right, BinaryFunction operation)
template<class BinaryFunction >
void binaryOp (DataExpanded &left, const DataReady &right, BinaryFunction operation)
ESCRIPT_DLL_API Data condEval (escript::Data &mask, escript::Data &trueval, escript::Data &falseval)
ESCRIPT_DLL_API Data randomData (const boost::python::tuple &shape, const FunctionSpace &what, long seed)
 Create a new Expanded Data object filled with (not very) random data.
char * Escript_MPI_appendRankToFileName (const char *, int, int)
double rpow (double x, double y)
ESCRIPT_DLL_API Data operator+ (const Data &left, const Data &right)
 Operator+ Takes two Data objects.
ESCRIPT_DLL_API Data operator- (const Data &left, const Data &right)
 Operator- Takes two Data objects.
ESCRIPT_DLL_API Data operator* (const Data &left, const Data &right)
 Operator* Takes two Data objects.
ESCRIPT_DLL_API Data operator/ (const Data &left, const Data &right)
 Operator/ Takes two Data objects.
ESCRIPT_DLL_API Data operator+ (const Data &left, const boost::python::object &right)
 Operator+ Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator- (const Data &left, const boost::python::object &right)
 Operator- Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator* (const Data &left, const boost::python::object &right)
 Operator* Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator/ (const Data &left, const boost::python::object &right)
 Operator/ Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator+ (const boost::python::object &left, const Data &right)
 Operator+ Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator- (const boost::python::object &left, const Data &right)
 Operator- Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator* (const boost::python::object &left, const Data &right)
 Operator* Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.
ESCRIPT_DLL_API Data operator/ (const boost::python::object &left, const Data &right)
 Operator/ Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.
ESCRIPT_DLL_API std::ostream & operator<< (std::ostream &o, const Data &data)
 Output operator.
ESCRIPT_DLL_API Data C_GeneralTensorProduct (Data &arg_0, Data &arg_1, int axis_offset=0, int transpose=0)
 Compute a tensor product of two Data objects.
template<typename BinaryFunction >
Data C_TensorBinaryOperation (Data const &arg_0, Data const &arg_1, BinaryFunction operation)
 Compute a tensor operation with two Data objects.
template<typename UnaryFunction >
Data C_TensorUnaryOperation (Data const &arg_0, UnaryFunction operation)
template<class BinaryFunction >
double algorithm (const DataExpanded &data, BinaryFunction operation, double initial_value)
 Perform the given operation upon all values in all data-points in the given Data object and return the final result.
template<class BinaryFunction >
double algorithm (DataTagged &data, BinaryFunction operation, double initial_value)
template<class BinaryFunction >
double algorithm (DataConstant &data, BinaryFunction operation, double initial_value)
template<class BinaryFunction >
void dp_algorithm (const DataExpanded &data, DataExpanded &result, BinaryFunction operation, double initial_value)
 Perform the given data-point reduction operation on all data-points in data, storing results in corresponding data-points of result.
template<class BinaryFunction >
void dp_algorithm (const DataTagged &data, DataTagged &result, BinaryFunction operation, double initial_value)
template<class BinaryFunction >
void dp_algorithm (DataConstant &data, DataConstant &result, BinaryFunction operation, double initial_value)
Data Scalar (double value, const FunctionSpace &what=FunctionSpace(), bool expanded=false)
 A collection of factory functions for creating Data objects which contain data points of various shapes.
Data Vector (double value, const FunctionSpace &what=FunctionSpace(), bool expanded=false)
 Return a Data object containing vector data-points. ie: rank 1 data-points.
Data VectorFromObj (boost::python::object o, const FunctionSpace &what, bool expanded)
Data Tensor (double value, const FunctionSpace &what=FunctionSpace(), bool expanded=false)
 Return a Data object containing tensor datapoints. ie: rank 2 data-points.
Data TensorFromObj (boost::python::object o, const FunctionSpace &what, bool expanded)
Data Tensor3 (double value, const FunctionSpace &what=FunctionSpace(), bool expanded=false)
 Return a Data object containing tensor3 datapoints. ie: rank 3 data-points.
Data Tensor3FromObj (boost::python::object o, const FunctionSpace &what, bool expanded)
Data Tensor4 (double value, const FunctionSpace &what=FunctionSpace(), bool expanded=false)
 Return a Data object containing tensor4 datapoints. ie: rank 4 data-points.
Data Tensor4FromObj (boost::python::object o, const FunctionSpace &what, bool expanded)
Data load (const std::string fileName, const AbstractDomain &domain)
 reads Data on domain from file in netCDF format
bool loadConfigured ()
 returns true if the load funtion is configured.
Data convertToData (const boost::python::object &value, const FunctionSpace &what=FunctionSpace())
 Tries to convert value into a Data object on FunctionSpace what. If value is already a Data object, the object is returned if it is defined on what otherwise interpolated data of values are returned. If value is not a data object it is tried to generate the corresponding data object. escript::DataEmpty() is returned if value is identified as empty.
const std::string & opToString (ES_optype op)
void releaseUnusedMemory ()
 releases unused memory in the memory manager.
binOpFnPtr binOpFnPtrFromVoidPtr (void *v)
void * voidPtrFromBinOpFnPtr (binOpFnPtr f)
void setEscriptParamInt (const char *name, int value)
 Set the value of a named parameter. See listEscriptParams() (showEscriptParams() in python) for available parameters.
int getEscriptParamInt (const char *name, int sentinel=0)
 get the value of a named parameter. See listEscriptParams() (showEscriptParams() in python) for available parameters.
ESCRIPT_DLL_API boost::python::list listEscriptParams ()
 describe available paramters.
FunctionSpace continuousFunction (const AbstractDomain &domain)
 Create function space objects.
FunctionSpace reducedContinuousFunction (const AbstractDomain &domain)
 Return a continuous with reduced order FunctionSpace (overlapped node values on reduced element order).
FunctionSpace function (const AbstractDomain &domain)
 Return a function FunctionSpace.
FunctionSpace reducedFunction (const AbstractDomain &domain)
 Return a function FunctionSpace with reduced integration order.
FunctionSpace functionOnBoundary (const AbstractDomain &domain)
 Return a function on boundary FunctionSpace.
FunctionSpace reducedFunctionOnBoundary (const AbstractDomain &domain)
 Return a function on boundary FunctionSpace with reduced integration order.
FunctionSpace functionOnContactZero (const AbstractDomain &domain)
 Return a FunctionSpace on left side of contact.
FunctionSpace reducedFunctionOnContactZero (const AbstractDomain &domain)
 Return a FunctionSpace on left side of contact with reduced integration order.
FunctionSpace functionOnContactOne (const AbstractDomain &domain)
 Return a FunctionSpace on right side of contact.
FunctionSpace reducedFunctionOnContactOne (const AbstractDomain &domain)
 Return a FunctionSpace on right side of contact with reduced integration order.
FunctionSpace solution (const AbstractDomain &domain)
 Return a FunctionSpace.
FunctionSpace reducedSolution (const AbstractDomain &domain)
 Return a FunctionSpace with reduced integration order.
FunctionSpace diracDeltaFunctions (const AbstractDomain &domain)
 Return a FunctionSpace.
bool nancheck (double d)
 acts as a wrapper to isnan.
double makeNaN ()
 returns a NaN.
void eigenvalues1 (const double A00, double *ev0)
 solves a 1x1 eigenvalue A*V=ev*V problem
void eigenvalues2 (const double A00, const double A01, const double A11, double *ev0, double *ev1)
 solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A
void eigenvalues3 (const double A00, const double A01, const double A02, const double A11, const double A12, const double A22, double *ev0, double *ev1, double *ev2)
 solves a 3x3 eigenvalue A*V=ev*V problem for symmetric A
void eigenvalues_and_eigenvectors1 (const double A00, double *ev0, double *V00, const double tol)
 solves a 1x1 eigenvalue A*V=ev*V problem for symmetric A
void vectorInKernel2 (const double A00, const double A10, const double A01, const double A11, double *V0, double *V1)
 returns a non-zero vector in the kernel of [[A00,A01],[A01,A11]] assuming that the kernel dimension is at least 1.
void vectorInKernel3__nonZeroA00 (const double A00, const double A10, const double A20, const double A01, const double A11, const double A21, const double A02, const double A12, const double A22, double *V0, double *V1, double *V2)
 returns a non-zero vector in the kernel of [[A00,A01,A02],[A10,A11,A12],[A20,A21,A22]] assuming that the kernel dimension is at least 1 and A00 is non zero.
void eigenvalues_and_eigenvectors2 (const double A00, const double A01, const double A11, double *ev0, double *ev1, double *V00, double *V10, double *V01, double *V11, const double tol)
 solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A. Eigenvectors are ordered by increasing value and eigen vectors are normalizeVector3d such that length is zero and first non-zero component is positive.
void normalizeVector3 (double *V0, double *V1, double *V2)
 nomalizes a 3-d vector such that length is one and first non-zero component is positive.
void eigenvalues_and_eigenvectors3 (const double A00, const double A01, const double A02, const double A11, const double A12, const double A22, double *ev0, double *ev1, double *ev2, double *V00, double *V10, double *V20, double *V01, double *V11, double *V21, double *V02, double *V12, double *V22, const double tol)
 solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A. Eigenvectors are ordered by increasing value and eigen vectors are normalizeVector3d such that length is zero and first non-zero component is positive.
void matrix_matrix_product (const int SL, const int SM, const int SR, const double *A, const double *B, double *C, int transpose)
template<typename UnaryFunction >
void tensor_unary_operation (const int size, const double *arg1, double *argRes, UnaryFunction operation)
template<typename BinaryFunction >
void tensor_binary_operation (const int size, const double *arg1, const double *arg2, double *argRes, BinaryFunction operation)
template<typename BinaryFunction >
void tensor_binary_operation (const int size, double arg1, const double *arg2, double *argRes, BinaryFunction operation)
template<typename BinaryFunction >
void tensor_binary_operation (const int size, const double *arg1, double arg2, double *argRes, BinaryFunction operation)
FunctionSpace getTestDomainFunctionSpace (int dpps, int samples)
double log1p (const double x)
float IEEE_NaN ()
double IEEE_Infy ()
double fsign (double x)
template<class UnaryFunction >
void unaryOp (DataExpanded &data, UnaryFunction operation)
 Perform the given unary operation on each data point of the given Data object. Called by Data::unaryOp. Calls DataArrayView::unaryOp. For DataExpanded objects, operation is done in parallel.
template<class UnaryFunction >
void unaryOp (DataTagged &data, UnaryFunction operation)
template<class UnaryFunction >
void unaryOp (DataConstant &data, UnaryFunction operation)
int getSvnVersion ()
 some functions
int get_core_id ()
void printParallelThreadCnt ()
 print a message about how many MPI CPUs and OpenMP threads we're using
void setNumberOfThreads (const int num_threads)
 set the number of threads
int getNumberOfThreads ()
 returns the number of threads
ESCRIPT_DLL_API int getMPISizeWorld ()
 returns the total number of available MPI processes for MPI_COMM_WORLD
ESCRIPT_DLL_API int getMPIRankWorld ()
 returns the MPI processor number within MPI_COMM_WORLD
ESCRIPT_DLL_API int getMPIWorldMax (const int val)
 returns the maximum value of an integer over all processors within MPI_COMM_WORLD
ESCRIPT_DLL_API int getMPIWorldSum (const int val)
 returns sum of an integer over all processors with MPI_COMM_WORLD
ESCRIPT_DLL_API int runMPIProgram (const boost::python::list args)
 uses MPI_Comm_spawn to run an external MPI program safely.
ESCRIPT_DLL_API double getMachinePrecision ()
 returns machine precision
ESCRIPT_DLL_API double getMaxFloat ()
ESCRIPT_DLL_API void MPIBarrierWorld ()
 performs a barrier synchronization across all processors.
ESCRIPT_DLL_API void saveDataCSV (const std::string &filename, boost::python::dict arg, const std::string &sep, const std::string &csep, bool append)
void resolveGroup (boost::python::object obj)

Variables

Taipan arrayManager
EscriptParams escriptParams

Typedef Documentation

typedef boost::shared_ptr<AbstractSystemMatrix> escript::ASM_ptr
typedef boost::shared_ptr<AbstractTransportProblem> escript::ATP_ptr
typedef int(* escript::binOpFnPtr)(double *, const double *, const double *, int, int, int)
typedef boost::shared_ptr< const DataAbstract > escript::const_DataAbstract_ptr
typedef boost::shared_ptr< const DataLazy > escript::const_DataLazy_ptr
typedef boost::shared_ptr< const DataReady > escript::const_DataReady_ptr
typedef boost::shared_ptr< const AbstractDomain > escript::const_Domain_ptr
typedef boost::shared_ptr< DataAbstract > escript::DataAbstract_ptr
typedef boost::shared_ptr< DataLazy > escript::DataLazy_ptr
typedef boost::shared_ptr< DataReady > escript::DataReady_ptr
typedef boost::shared_ptr< AbstractDomain > escript::Domain_ptr

Enumeration Type Documentation

enum escript::ES_optype
Enumerator:
UNKNOWNOP 
IDENTITY 
ADD 
SUB 
MUL 
DIV 
POW 
SIN 
COS 
TAN 
ASIN 
ACOS 
ATAN 
SINH 
COSH 
TANH 
ERF 
ASINH 
ACOSH 
ATANH 
LOG10 
LOG 
SIGN 
ABS 
NEG 
POS 
EXP 
SQRT 
RECIP 
GZ 
LZ 
GEZ 
LEZ 
NEZ 
EZ 
SYM 
NSYM 
PROD 
TRANS 
TRACE 
SWAP 
MINVAL 
MAXVAL 
CONDEVAL 

Function Documentation

template<class BinaryFunction >
double escript::algorithm ( const DataExpanded &  data,
BinaryFunction  operation,
double  initial_value 
) [inline]

Perform the given operation upon all values in all data-points in the given Data object and return the final result.

References escript::DataAbstract::getNumDPPSample(), escript::DataAbstract::getNumSamples(), escript::DataExpanded::getPointOffset(), escript::DataAbstract::getShape(), escript::DataExpanded::getVectorRO(), and escript::DataMaths::reductionOp().

template<class BinaryFunction >
double escript::algorithm ( DataTagged &  data,
BinaryFunction  operation,
double  initial_value 
) [inline]

References escript::DataTagged::getDefaultOffset(), escript::DataAbstract::getFunctionSpace(), escript::FunctionSpace::getListOfTagsSTL(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), escript::DataTagged::getVectorRO(), and escript::DataMaths::reductionOp().

template<class BinaryFunction >
double escript::algorithm ( DataConstant &  data,
BinaryFunction  operation,
double  initial_value 
) [inline]

References escript::DataAbstract::getShape(), escript::DataConstant::getVectorRO(), and escript::DataMaths::reductionOp().

template<class BinaryFunction >
void escript::binaryOp ( DataTagged &  left,
const DataTagged &  right,
BinaryFunction  operation 
) [inline]

References escript::DataTagged::addTag(), escript::DataMaths::binaryOp(), escript::DataTagged::getDataByTagRO(), escript::DataTagged::getDefaultOffset(), escript::DataTagged::getOffsetForTag(), escript::DataAbstract::getRank(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), escript::DataTagged::getVectorRO(), escript::DataTagged::getVectorRW(), and escript::DataTagged::isCurrentTag().

template<class BinaryFunction >
void escript::binaryOp ( DataConstant &  left,
const DataConstant &  right,
BinaryFunction  operation 
) [inline]

References escript::DataMaths::binaryOp(), escript::DataAbstract::getShape(), escript::DataConstant::getVectorRO(), and escript::DataConstant::getVectorRW().

template<class BinaryFunction >
void escript::binaryOp ( DataTagged &  left,
const DataTypes::ValueType &  right,
const DataTypes::ShapeType &  shape,
BinaryFunction  operation 
) [inline]

apply the binary op to each value in left and the single value right.

The value in right will be assumed to begin at offset 0

References escript::DataMaths::binaryOp(), escript::DataTagged::getDefaultOffset(), escript::DataTypes::getRank(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), and escript::DataTagged::getVectorRW().

template<class BinaryFunction >
void escript::binaryOp ( DataExpanded &  left,
const DataReady &  right,
BinaryFunction  operation 
) [inline]

References escript::DataMaths::binaryOp(), escript::DataAbstract::getNumDPPSample(), escript::DataAbstract::getNumSamples(), escript::DataAbstract::getPointOffset(), escript::DataExpanded::getPointOffset(), escript::DataAbstract::getRank(), escript::DataAbstract::getShape(), escript::DataReady::getVectorRO(), and escript::DataExpanded::getVectorRW().

template<class BinaryFunction >
void escript::binaryOp ( DataTagged &  left,
const DataConstant &  right,
BinaryFunction  operation 
) [inline]

Perform the given binary operation.

Parameters:
left Input/Output - The left hand side.
right Input - The right hand side.
operation Input - The operation to perform.

References escript::DataMaths::binaryOp(), escript::DataTagged::getDefaultOffset(), escript::DataAbstract::getRank(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), escript::DataConstant::getVectorRO(), and escript::DataTagged::getVectorRW().

binOpFnPtr escript::binOpFnPtrFromVoidPtr ( void *  v  ) 

Casts a void* to a function pointer taking 3 double* and 3 int

Warning:
The C standard does not guarantee that void* and function pointer are the same size.

Why do we have this? To allow us to pass function pointers between modules via python. To do this without using a custom object we use void*

Data escript::C_GeneralTensorProduct ( escript::Data &  arg_0,
escript::Data &  arg_1,
int  axis_offset = 0,
int  transpose = 0 
)

Compute a tensor product of two Data objects.

Parameters:
arg_0 - Input - Data object
arg_1 - Input - Data object
axis_offset - Input - axis offset
transpose - Input - 0: transpose neither, 1: transpose arg0, 2: transpose arg1

References escript::DataTagged::addTag(), AUTOLAZYON, escript::Data::borrowData(), escript::Data::borrowDataPtr(), ESCRIPT_MAX_DATA_RANK, escript::Data::getDataAtOffsetRO(), escript::Data::getDataAtOffsetRW(), escript::DataTagged::getDataByTagRO(), escript::DataTagged::getDataByTagRW(), escript::Data::getDataPointRank(), escript::Data::getDataPointShape(), escript::DataTagged::getDefaultValueRO(), escript::DataTagged::getDefaultValueRW(), escript::Data::getFunctionSpace(), escript::Data::getNumDataPointsPerSample(), escript::Data::getNumSamples(), escript::DataTagged::getPointOffset(), escript::DataExpanded::getPointOffset(), escript::DataConstant::getPointOffset(), escript::DataTagged::getTagLookup(), escript::Data::interpolate(), escript::Data::isConstant(), escript::Data::isExpanded(), escript::Data::isLazy(), escript::Data::isTagged(), matrix_matrix_product(), escript::Data::probeInterpolation(), and escript::Data::tag().

Referenced by BOOST_PYTHON_MODULE(), and escript::DataLazy::collapseToReady().

template<typename BinaryFunction >
Data escript::C_TensorBinaryOperation ( Data const &  arg_0,
Data const &  arg_1,
BinaryFunction  operation 
) [inline]

Compute a tensor operation with two Data objects.

Parameters:
arg_0 - Input - Data object
arg_1 - Input - Data object
operation - Input - Binary op functor

References escript::DataTagged::addTag(), escript::Data::borrowData(), escript::Data::getDataAtOffsetRO(), escript::Data::getDataAtOffsetRW(), escript::DataTagged::getDataByTagRO(), escript::DataTagged::getDataByTagRW(), escript::Data::getDataPointRank(), escript::Data::getDataPointShape(), escript::Data::getDataPointSize(), escript::DataTagged::getDefaultValueRO(), escript::DataTagged::getDefaultValueRW(), escript::Data::getFunctionSpace(), escript::Data::getNumDataPointsPerSample(), escript::Data::getNumSamples(), escript::DataTagged::getPointOffset(), escript::DataExpanded::getPointOffset(), escript::DataConstant::getPointOffset(), escript::DataTagged::getTagLookup(), escript::Data::interpolate(), escript::Data::isConstant(), escript::Data::isEmpty(), escript::Data::isExpanded(), escript::Data::isLazy(), escript::Data::isTagged(), escript::Data::probeInterpolation(), escript::Data::requireWrite(), escript::Data::tag(), and tensor_binary_operation().

Referenced by operator*(), operator+(), operator-(), and operator/().

template<typename UnaryFunction >
Data escript::C_TensorUnaryOperation ( Data const &  arg_0,
UnaryFunction  operation 
)

References escript::DataTagged::addTag(), escript::Data::borrowData(), escript::Data::getDataAtOffsetRO(), escript::Data::getDataAtOffsetRW(), escript::DataTagged::getDataByTagRO(), escript::DataTagged::getDataByTagRW(), escript::Data::getDataPointShape(), escript::Data::getDataPointSize(), escript::DataTagged::getDefaultValueRO(), escript::DataTagged::getDefaultValueRW(), escript::Data::getFunctionSpace(), escript::Data::getNumDataPointsPerSample(), escript::Data::getNumSamples(), escript::DataExpanded::getPointOffset(), escript::DataTagged::getTagLookup(), escript::Data::isConstant(), escript::Data::isEmpty(), escript::Data::isExpanded(), escript::Data::isLazy(), escript::Data::isTagged(), escript::Data::tag(), and tensor_unary_operation().

Referenced by escript::Data::acosh(), escript::Data::asinh(), escript::Data::atanh(), escript::Data::erf(), escript::Data::neg(), escript::Data::oneOver(), escript::Data::sign(), escript::Data::whereNegative(), escript::Data::whereNonNegative(), escript::Data::whereNonPositive(), escript::Data::whereNonZero(), escript::Data::wherePositive(), and escript::Data::whereZero().

Data escript::condEval ( escript::Data &  mask,
escript::Data &  trueval,
escript::Data &  falseval 
)

References escript::Data::actsExpanded(), escript::DataTagged::addTaggedValue(), escript::Data::borrowDataPtr(), escript::Data::expand(), escript::DataTagged::getDataByTagRO(), escript::Data::getDataPointRank(), escript::Data::getDataPointShape(), escript::Data::getDataPointSize(), escript::DataTagged::getDefaultValueRO(), escript::DataTagged::getDefaultValueRW(), escript::Data::getFunctionSpace(), escript::DataTagged::getOffsetForTag(), escript::Data::getReady(), escript::Data::getSampleDataRO(), escript::DataTagged::getTagLookup(), escript::DataTagged::getVectorRO(), escript::Data::isConstant(), escript::Data::isLazy(), escript::Data::isTagged(), escript::Data::resolve(), and escript::Data::tag().

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::continuousFunction ( const AbstractDomain &  domain  ) 

Create function space objects.

Description: Create function space objects.

Return a continuous FunctionSpace (overlapped node values)

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getX(), dudley::MeshAdapter::getX(), finley::MeshAdapter::interpolateOnDomain(), dudley::MeshAdapter::interpolateOnDomain(), finley::MeshAdapter::setNewX(), dudley::MeshAdapter::setNewX(), finley::MeshAdapter::setToGradient(), dudley::MeshAdapter::setToGradient(), finley::MeshAdapter::setToX(), and dudley::MeshAdapter::setToX().

ESCRIPT_DLL_API Data escript::convertToData ( const boost::python::object &  value,
const FunctionSpace &  what 
)

Tries to convert value into a Data object on FunctionSpace what. If value is already a Data object, the object is returned if it is defined on what otherwise interpolated data of values are returned. If value is not a data object it is tried to generate the corresponding data object. escript::DataEmpty() is returned if value is identified as empty.

ESCRIPT_DLL_API FunctionSpace escript::diracDeltaFunctions ( const AbstractDomain &  domain  ) 

Return a FunctionSpace.

Referenced by BOOST_PYTHON_MODULE().

template<class BinaryFunction >
void escript::dp_algorithm ( DataConstant &  data,
DataConstant &  result,
BinaryFunction  operation,
double  initial_value 
) [inline]

References escript::DataAbstract::getShape(), escript::DataConstant::getVectorRO(), escript::DataConstant::getVectorRW(), and escript::DataMaths::reductionOp().

template<class BinaryFunction >
void escript::dp_algorithm ( const DataExpanded &  data,
DataExpanded &  result,
BinaryFunction  operation,
double  initial_value 
) [inline]

Perform the given data-point reduction operation on all data-points in data, storing results in corresponding data-points of result.

Objects data and result must be of the same type, and have the same number of data points, but where data has data points of rank n, result must have data points of rank 0.

Calls DataArrayView::reductionOp

References escript::DataAbstract::getNumDPPSample(), escript::DataAbstract::getNumSamples(), escript::DataExpanded::getPointOffset(), escript::DataAbstract::getShape(), escript::DataExpanded::getVectorRO(), escript::DataExpanded::getVectorRW(), and escript::DataMaths::reductionOp().

template<class BinaryFunction >
void escript::dp_algorithm ( const DataTagged &  data,
DataTagged &  result,
BinaryFunction  operation,
double  initial_value 
) [inline]

References escript::DataTagged::getDataByTagRW(), escript::DataTagged::getDefaultOffset(), escript::DataTagged::getOffsetForTag(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), escript::DataTagged::getVectorRO(), escript::DataTagged::getVectorRW(), and escript::DataMaths::reductionOp().

void escript::eigenvalues1 ( const double  A00,
double *  ev0 
) [inline]

solves a 1x1 eigenvalue A*V=ev*V problem

Parameters:
A00 Input - A_00
ev0 Output - eigenvalue

Referenced by escript::DataMaths::eigenvalues(), and eigenvalues_and_eigenvectors1().

void escript::eigenvalues2 ( const double  A00,
const double  A01,
const double  A11,
double *  ev0,
double *  ev1 
) [inline]

solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A

Parameters:
A00 Input - A_00
A01 Input - A_01
A11 Input - A_11
ev0 Output - smallest eigenvalue
ev1 Output - largest eigenvalue

Referenced by escript::DataMaths::eigenvalues(), and eigenvalues_and_eigenvectors2().

void escript::eigenvalues3 ( const double  A00,
const double  A01,
const double  A02,
const double  A11,
const double  A12,
const double  A22,
double *  ev0,
double *  ev1,
double *  ev2 
) [inline]

solves a 3x3 eigenvalue A*V=ev*V problem for symmetric A

Parameters:
A00 Input - A_00
A01 Input - A_01
A02 Input - A_02
A11 Input - A_11
A12 Input - A_12
A22 Input - A_22
ev0 Output - smallest eigenvalue
ev1 Output - eigenvalue
ev2 Output - largest eigenvalue

References M_PI.

Referenced by escript::DataMaths::eigenvalues(), and eigenvalues_and_eigenvectors3().

void escript::eigenvalues_and_eigenvectors1 ( const double  A00,
double *  ev0,
double *  V00,
const double  tol 
) [inline]

solves a 1x1 eigenvalue A*V=ev*V problem for symmetric A

Parameters:
A00 Input - A_00
ev0 Output - eigenvalue
V00 Output - eigenvector
tol Input - tolerance to identify to eigenvalues

References eigenvalues1().

Referenced by escript::DataMaths::eigenvalues_and_eigenvectors().

void escript::eigenvalues_and_eigenvectors2 ( const double  A00,
const double  A01,
const double  A11,
double *  ev0,
double *  ev1,
double *  V00,
double *  V10,
double *  V01,
double *  V11,
const double  tol 
) [inline]

solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A. Eigenvectors are ordered by increasing value and eigen vectors are normalizeVector3d such that length is zero and first non-zero component is positive.

Parameters:
A00 Input - A_00
A01 Input - A_01
A11 Input - A_11
ev0 Output - smallest eigenvalue
ev1 Output - eigenvalue
V00 Output - eigenvector componenent coresponding to ev0
V10 Output - eigenvector componenent coresponding to ev0
V01 Output - eigenvector componenent coresponding to ev1
V11 Output - eigenvector componenent coresponding to ev1
tol Input - tolerance to identify to eigenvalues

References eigenvalues2(), and vectorInKernel2().

Referenced by escript::DataMaths::eigenvalues_and_eigenvectors(), and eigenvalues_and_eigenvectors3().

void escript::eigenvalues_and_eigenvectors3 ( const double  A00,
const double  A01,
const double  A02,
const double  A11,
const double  A12,
const double  A22,
double *  ev0,
double *  ev1,
double *  ev2,
double *  V00,
double *  V10,
double *  V20,
double *  V01,
double *  V11,
double *  V21,
double *  V02,
double *  V12,
double *  V22,
const double  tol 
) [inline]

solves a 2x2 eigenvalue A*V=ev*V problem for symmetric A. Eigenvectors are ordered by increasing value and eigen vectors are normalizeVector3d such that length is zero and first non-zero component is positive.

Parameters:
A00 Input - A_00
A01 Input - A_01
A02 Input - A_02
A11 Input - A_11
A12 Input - A_12
A22 Input - A_22
ev0 Output - smallest eigenvalue
ev1 Output - eigenvalue
ev2 Output -
V00 Output - eigenvector componenent coresponding to ev0
V10 Output - eigenvector componenent coresponding to ev0
V20 Output -
V01 Output - eigenvector componenent coresponding to ev1
V11 Output - eigenvector componenent coresponding to ev1
V21 Output -
V02 Output -
V12 Output -
V22 Output -
tol Input - tolerance to identify to eigenvalues

References eigenvalues3(), eigenvalues_and_eigenvectors2(), normalizeVector3(), and vectorInKernel3__nonZeroA00().

Referenced by escript::DataMaths::eigenvalues_and_eigenvectors().

char * escript::Escript_MPI_appendRankToFileName ( const char *  fileName,
int  mpi_size,
int  mpi_rank 
)

Modify a filename for MPI parallel output to multiple files

References esysUtils::malloc().

Referenced by escript::DataTagged::dump(), escript::DataExpanded::dump(), and escript::DataConstant::dump().

double escript::fsign ( double  x  )  [inline]

Referenced by escript::DataLazy::resolveNodeUnary(), and escript::Data::sign().

ESCRIPT_DLL_API FunctionSpace escript::function ( const AbstractDomain &  domain  ) 

Return a function FunctionSpace.

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getSize(), dudley::MeshAdapter::getSize(), escript::Data::grad(), finley::MeshAdapter::setToIntegrals(), and dudley::MeshAdapter::setToIntegrals().

ESCRIPT_DLL_API FunctionSpace escript::functionOnBoundary ( const AbstractDomain &  domain  ) 

Return a function on boundary FunctionSpace.

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::getNormal(), and dudley::MeshAdapter::getNormal().

ESCRIPT_DLL_API FunctionSpace escript::functionOnContactOne ( const AbstractDomain &  domain  ) 

Return a FunctionSpace on right side of contact.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::functionOnContactZero ( const AbstractDomain &  domain  ) 

Return a FunctionSpace on left side of contact.

Referenced by BOOST_PYTHON_MODULE().

int escript::get_core_id (  ) 
ESCRIPT_DLL_API int escript::getEscriptParamInt ( const char *  name,
int  sentinel 
)

get the value of a named parameter. See listEscriptParams() (showEscriptParams() in python) for available parameters.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API double escript::getMachinePrecision (  ) 

returns machine precision

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API double escript::getMaxFloat (  ) 

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API int escript::getMPIRankWorld (  ) 

returns the MPI processor number within MPI_COMM_WORLD

Referenced by BOOST_PYTHON_MODULE(), and escript::TestDomain::TestDomain().

ESCRIPT_DLL_API int escript::getMPISizeWorld (  ) 

returns the total number of available MPI processes for MPI_COMM_WORLD

Referenced by BOOST_PYTHON_MODULE(), and escript::TestDomain::TestDomain().

ESCRIPT_DLL_API int escript::getMPIWorldMax ( const int  val  ) 

returns the maximum value of an integer over all processors within MPI_COMM_WORLD

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API int escript::getMPIWorldSum ( const int  val  ) 

returns sum of an integer over all processors with MPI_COMM_WORLD

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API int escript::getNumberOfThreads (  ) 

returns the number of threads

Referenced by BOOST_PYTHON_MODULE(), and escript::DataLazy::resolveNodeWorker().

ESCRIPT_DLL_API int escript::getSvnVersion (  ) 

some functions

return the SVN version number used to build this version.

Warning:
Only gives accurate answers for clean checkouts

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::getTestDomainFunctionSpace ( int  dpps,
int  samples 
)

Referenced by BOOST_PYTHON_MODULE().

double escript::IEEE_Infy (  )  [inline]
float escript::IEEE_NaN (  )  [inline]
ESCRIPT_DLL_API boost::python::list escript::listEscriptParams (  )  [inline]

describe available paramters.

Returns:
a list of tuples (parameter name, value, description)

References escriptParams, and escript::EscriptParams::listEscriptParams().

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::load ( const std::string  fileName,
const AbstractDomain &  domain 
)

reads Data on domain from file in netCDF format

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API bool escript::loadConfigured (  ) 

returns true if the load funtion is configured.

Referenced by BOOST_PYTHON_MODULE().

double escript::log1p ( const double  x  )  [inline]
double escript::makeNaN (  )  [inline]

returns a NaN.

Warning:
Should probably only used where you know you can test for NaNs

Referenced by escript::Data::infWorker(), escript::Data::lazyAlgWorker(), escript::Data::LsupWorker(), and escript::Data::supWorker().

void escript::matrix_matrix_product ( const int  SL,
const int  SM,
const int  SR,
const double *  A,
const double *  B,
double *  C,
int  transpose 
) [inline]

Referenced by C_GeneralTensorProduct(), and escript::DataLazy::resolveNodeTProd().

ESCRIPT_DLL_API void escript::MPIBarrierWorld (  ) 

performs a barrier synchronization across all processors.

Referenced by BOOST_PYTHON_MODULE().

bool escript::nancheck ( double  d  )  [inline]

acts as a wrapper to isnan.

Warning:
if compiler does not support FP_NAN this function will always return false.

Referenced by escript::DataTagged::hasNaN(), escript::DataExpanded::hasNaN(), escript::DataConstant::hasNaN(), and escript::DataMaths::vectorHasNaN().

void escript::normalizeVector3 ( double *  V0,
double *  V1,
double *  V2 
) [inline]

nomalizes a 3-d vector such that length is one and first non-zero component is positive.

Parameters:
V0 - vector componenent
V1 - vector componenent
V2 - vector componenent

Referenced by eigenvalues_and_eigenvectors3().

Data escript::operator* ( const Data &  left,
const boost::python::object &  right 
)

Operator* Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.

References escript::Data::getFunctionSpace(), MAKELAZYBIN2, and MUL.

ESCRIPT_DLL_API Data escript::operator* ( const AbstractSystemMatrix &  left,
const Data &  right 
)
Data escript::operator* ( const boost::python::object &  left,
const Data &  right 
)

Operator* Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.

References escript::Data::getFunctionSpace(), MAKELAZYBIN2, and MUL.

Data escript::operator* ( const Data &  left,
const Data &  right 
)

Operator* Takes two Data objects.

References C_TensorBinaryOperation(), MAKELAZYBIN2, and MUL.

Data escript::operator+ ( const boost::python::object &  left,
const Data &  right 
)

Operator+ Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.

References ADD, escript::Data::getFunctionSpace(), and MAKELAZYBIN2.

Data escript::operator+ ( const Data &  left,
const Data &  right 
)

Operator+ Takes two Data objects.

References ADD, C_TensorBinaryOperation(), and MAKELAZYBIN2.

Data escript::operator+ ( const Data &  left,
const boost::python::object &  right 
)

Operator+ Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.

References ADD, escript::Data::getFunctionSpace(), and MAKELAZYBIN2.

Data escript::operator- ( const boost::python::object &  left,
const Data &  right 
)

Operator- Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.

References escript::Data::getFunctionSpace(), MAKELAZYBIN2, and SUB.

Data escript::operator- ( const Data &  left,
const boost::python::object &  right 
)

Operator- Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.

References escript::Data::getFunctionSpace(), MAKELAZYBIN2, and SUB.

Data escript::operator- ( const Data &  left,
const Data &  right 
)

Operator- Takes two Data objects.

References C_TensorBinaryOperation(), MAKELAZYBIN2, and SUB.

Data escript::operator/ ( const boost::python::object &  left,
const Data &  right 
)

Operator/ Takes LHS python::object and RHS Data object. python::object must be convertable to Data type.

References DIV, escript::Data::getFunctionSpace(), and MAKELAZYBIN2.

Data escript::operator/ ( const Data &  left,
const boost::python::object &  right 
)

Operator/ Takes LHS Data object and RHS python::object. python::object must be convertable to Data type.

References DIV, escript::Data::getFunctionSpace(), and MAKELAZYBIN2.

Data escript::operator/ ( const Data &  left,
const Data &  right 
)

Operator/ Takes two Data objects.

References C_TensorBinaryOperation(), DIV, and MAKELAZYBIN2.

ostream & escript::operator<< ( std::ostream &  o,
const Data &  data 
)

Output operator.

References escript::Data::toString().

ESCRIPT_DLL_API const std::string & escript::opToString ( ES_optype  op  ) 

Referenced by escript::DataLazy::collapseToReady(), escript::DataLazy::deepCopy(), escript::DataLazy::intoString(), escript::DataLazy::intoTreeString(), escript::DataLazy::resolveNodeBinary(), escript::DataLazy::resolveNodeNP1OUT(), escript::DataLazy::resolveNodeNP1OUT_2P(), escript::DataLazy::resolveNodeNP1OUT_P(), escript::DataLazy::resolveNodeReduction(), escript::DataLazy::resolveNodeSample(), escript::DataLazy::resolveNodeTProd(), and escript::DataLazy::resolveNodeUnary().

ESCRIPT_DLL_API void escript::printParallelThreadCnt (  ) 

print a message about how many MPI CPUs and OpenMP threads we're using

Referenced by BOOST_PYTHON_MODULE().

Data escript::randomData ( const boost::python::tuple &  shape,
const FunctionSpace &  what,
long  seed 
)

Create a new Expanded Data object filled with (not very) random data.

References escript::Data::m_data, and escript::DataExpanded::randomFill().

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::reducedContinuousFunction ( const AbstractDomain &  domain  ) 

Return a continuous with reduced order FunctionSpace (overlapped node values on reduced element order).

Referenced by BOOST_PYTHON_MODULE(), finley::MeshAdapter::interpolateOnDomain(), dudley::MeshAdapter::interpolateOnDomain(), finley::MeshAdapter::setToGradient(), and dudley::MeshAdapter::setToGradient().

ESCRIPT_DLL_API FunctionSpace escript::reducedFunction ( const AbstractDomain &  domain  ) 

Return a function FunctionSpace with reduced integration order.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::reducedFunctionOnBoundary ( const AbstractDomain &  domain  ) 

Return a function on boundary FunctionSpace with reduced integration order.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::reducedFunctionOnContactOne ( const AbstractDomain &  domain  ) 

Return a FunctionSpace on right side of contact with reduced integration order.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::reducedFunctionOnContactZero ( const AbstractDomain &  domain  ) 

Return a FunctionSpace on left side of contact with reduced integration order.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::reducedSolution ( const AbstractDomain &  domain  ) 

Return a FunctionSpace with reduced integration order.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API void escript::releaseUnusedMemory (  ) 

releases unused memory in the memory manager.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API void escript::resolveGroup ( boost::python::object  obj  ) 

Resolve a collection of Data objects together now. To get performance improvements, the objects will need to have the same function space and share Dag components.

Parameters:
obj A python list or tuple of Data objects to be resolved together.

Referenced by BOOST_PYTHON_MODULE().

double escript::rpow ( double  x,
double  y 
) [inline]

Binary Data object operators.

ESCRIPT_DLL_API int escript::runMPIProgram ( boost::python::list  args  ) 

uses MPI_Comm_spawn to run an external MPI program safely.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API void escript::saveDataCSV ( const std::string &  filename,
boost::python::dict  arg,
const std::string &  sep,
const std::string &  csep,
bool  append 
)

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Scalar ( double  value,
const FunctionSpace &  what = FunctionSpace(),
bool  expanded = false 
)

A collection of factory functions for creating Data objects which contain data points of various shapes.

Return a Data object containing scalar data-points. ie: rank 0 data-points.

Parameters:
value - Input - Single value applied to all Data.
what - Input - A description of what this data represents.
expanded - Input - if true fill the entire container with the value. Otherwise a more efficient storage mechanism will be used.

Referenced by BOOST_PYTHON_MODULE(), and escript::FunctionSpace::getSize().

ESCRIPT_DLL_API void escript::setEscriptParamInt ( const char *  name,
int  value 
)

Set the value of a named parameter. See listEscriptParams() (showEscriptParams() in python) for available parameters.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API void escript::setNumberOfThreads ( const int  num_threads  ) 

set the number of threads

Warning:
Use of this method is strongly discouraged. It may be deprecated in future.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API FunctionSpace escript::solution ( const AbstractDomain &  domain  ) 

Return a FunctionSpace.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Tensor ( double  value,
const FunctionSpace &  what,
bool  expanded 
)

Return a Data object containing tensor datapoints. ie: rank 2 data-points.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Tensor3 ( double  value,
const FunctionSpace &  what,
bool  expanded 
)

Return a Data object containing tensor3 datapoints. ie: rank 3 data-points.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Tensor3FromObj ( boost::python::object  o,
const FunctionSpace &  what,
bool  expanded 
)

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Tensor4 ( double  value,
const FunctionSpace &  what,
bool  expanded 
)

Return a Data object containing tensor4 datapoints. ie: rank 4 data-points.

Referenced by BOOST_PYTHON_MODULE().

ESCRIPT_DLL_API Data escript::Tensor4FromObj ( boost::python::object  o,
const FunctionSpace &  what,
bool  expanded 
)

Referenced by BOOST_PYTHON_MODULE().

template<typename BinaryFunction >
void escript::tensor_binary_operation ( const int  size,
double  arg1,
const double *  arg2,
double *  argRes,
BinaryFunction  operation 
) [inline]
template<typename BinaryFunction >
void escript::tensor_binary_operation ( const int  size,
const double *  arg1,
double  arg2,
double *  argRes,
BinaryFunction  operation 
) [inline]
template<typename BinaryFunction >
void escript::tensor_binary_operation ( const int  size,
const double *  arg1,
const double *  arg2,
double *  argRes,
BinaryFunction  operation 
) [inline]

Referenced by C_TensorBinaryOperation().

template<typename UnaryFunction >
void escript::tensor_unary_operation ( const int  size,
const double *  arg1,
double *  argRes,
UnaryFunction  operation 
) [inline]

Referenced by C_TensorUnaryOperation(), and escript::DataLazy::resolveNodeUnary().

ESCRIPT_DLL_API Data escript::TensorFromObj ( boost::python::object  o,
const FunctionSpace &  what,
bool  expanded 
)

Referenced by BOOST_PYTHON_MODULE().

template<class UnaryFunction >
void escript::unaryOp ( DataExpanded &  data,
UnaryFunction  operation 
) [inline]

Perform the given unary operation on each data point of the given Data object. Called by Data::unaryOp. Calls DataArrayView::unaryOp. For DataExpanded objects, operation is done in parallel.

Parameters:
data Input/Output - The data.
operation Input - The operation to perform.

References escript::DataAbstract::getNumDPPSample(), escript::DataAbstract::getNumSamples(), escript::DataExpanded::getPointOffset(), escript::DataAbstract::getShape(), escript::DataExpanded::getVectorRW(), and escript::DataMaths::unaryOp().

template<class UnaryFunction >
void escript::unaryOp ( DataConstant &  data,
UnaryFunction  operation 
) [inline]

References escript::DataAbstract::getShape(), escript::DataConstant::getVectorRW(), and escript::DataMaths::unaryOp().

template<class UnaryFunction >
void escript::unaryOp ( DataTagged &  data,
UnaryFunction  operation 
) [inline]

References escript::DataTagged::getDefaultOffset(), escript::DataAbstract::getShape(), escript::DataTagged::getTagLookup(), escript::DataTagged::getVectorRW(), and escript::DataMaths::unaryOp().

ESCRIPT_DLL_API Data escript::Vector ( double  value,
const FunctionSpace &  what,
bool  expanded 
)

Return a Data object containing vector data-points. ie: rank 1 data-points.

Referenced by BOOST_PYTHON_MODULE(), escript::FunctionSpace::getNormal(), escript::FunctionSpace::getX(), finley::MeshAdapter::setToX(), and dudley::MeshAdapter::setToX().

ESCRIPT_DLL_API Data escript::VectorFromObj ( boost::python::object  o,
const FunctionSpace &  what,
bool  expanded 
)

Referenced by BOOST_PYTHON_MODULE().

void escript::vectorInKernel2 ( const double  A00,
const double  A10,
const double  A01,
const double  A11,
double *  V0,
double *  V1 
) [inline]

returns a non-zero vector in the kernel of [[A00,A01],[A01,A11]] assuming that the kernel dimension is at least 1.

Parameters:
A00 Input - matrix component
A10 Input - matrix component
A01 Input - matrix component
A11 Input - matrix component
V0 Output - vector component
V1 Output - vector component

Referenced by eigenvalues_and_eigenvectors2(), and vectorInKernel3__nonZeroA00().

void escript::vectorInKernel3__nonZeroA00 ( const double  A00,
const double  A10,
const double  A20,
const double  A01,
const double  A11,
const double  A21,
const double  A02,
const double  A12,
const double  A22,
double *  V0,
double *  V1,
double *  V2 
) [inline]

returns a non-zero vector in the kernel of [[A00,A01,A02],[A10,A11,A12],[A20,A21,A22]] assuming that the kernel dimension is at least 1 and A00 is non zero.

Parameters:
A00 Input - matrix component
A10 Input - matrix component
A20 Input - matrix component
A01 Input - matrix component
A11 Input - matrix component
A21 Input - matrix component
A02 Input - matrix component
A12 Input - matrix component
A22 Input - matrix component
V0 Output - vector component
V1 Output - vector component
V2 Output - vector component

References vectorInKernel2().

Referenced by eigenvalues_and_eigenvectors3().

void * escript::voidPtrFromBinOpFnPtr ( binOpFnPtr  f  ) 

Why do we have this? Only to act as an inverse to the above function

Variable Documentation

Taipan escript::arrayManager

Referenced by escript::DataVector::copyFromArray(), escript::DataVector::DataVector(), escript::DataVector::operator=(), escript::DataVector::resize(), and escript::DataVector::~DataVector().

EscriptParams escript::escriptParams

Referenced by listEscriptParams(), escript::DataLazy::toString(), and escript::Data::toString().

Generated on Fri May 25 2012 00:38:57 for ESYS13 by  doxygen 1.7.1