chaste.core package

Module contents

Core Module

class chaste.core.OutputFileHandler

CopyFileTo((OutputFileHandler)arg1, (FileFinder)rSourceFile) → FileFinder :

C++ signature :

FileFinder CopyFileTo(OutputFileHandler {lvalue},FileFinder)

FindFile((OutputFileHandler)arg1, (str)leafName) → FileFinder :

C++ signature :

FileFinder FindFile(OutputFileHandler {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

static GetChasteTestOutputDirectory() → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetChasteTestOutputDirectory()

GetOutputDirectoryFullPath((OutputFileHandler)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetOutputDirectoryFullPath(OutputFileHandler {lvalue})

GetRelativePath((OutputFileHandler)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetRelativePath(OutputFileHandler {lvalue})

SetArchiveDirectory((OutputFileHandler)arg1) → None :

C++ signature :

void SetArchiveDirectory(OutputFileHandler {lvalue})

class chaste.core.RelativeTo

class chaste.core.FileFinder

CopyTo((FileFinder)arg1, (FileFinder)rDest) → FileFinder :

C++ signature :

FileFinder CopyTo(FileFinder {lvalue},FileFinder)

DangerousRemove((FileFinder)arg1) → None :

C++ signature :

void DangerousRemove(FileFinder {lvalue})

Exists((FileFinder)arg1) → bool :

C++ signature :

bool Exists(FileFinder {lvalue})

static FakePath((Value)fakeWhat, (str)rFakePath) → None :

C++ signature :

void FakePath(RelativeTo::Value,std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

GetAbsolutePath((FileFinder)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetAbsolutePath(FileFinder {lvalue})

GetExtension((FileFinder)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetExtension(FileFinder {lvalue})

GetLeafName((FileFinder)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetLeafName(FileFinder {lvalue})

GetLeafNameNoExtension((FileFinder)arg1) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetLeafNameNoExtension(FileFinder {lvalue})

GetParent((FileFinder)arg1) → FileFinder :

C++ signature :

FileFinder GetParent(FileFinder {lvalue})

GetRelativePath((FileFinder)arg1, (FileFinder)rBasePath) → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetRelativePath(FileFinder {lvalue},FileFinder)

static IsAbsolutePath((str)rPath) → bool :

C++ signature :

bool IsAbsolutePath(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

IsDir((FileFinder)arg1) → bool :

C++ signature :

bool IsDir(FileFinder {lvalue})

IsEmpty((FileFinder)arg1) → bool :

C++ signature :

bool IsEmpty(FileFinder {lvalue})

IsFile((FileFinder)arg1) → bool :

C++ signature :

bool IsFile(FileFinder {lvalue})

IsNewerThan((FileFinder)arg1, (FileFinder)rOtherEntity) → bool :

C++ signature :

bool IsNewerThan(FileFinder {lvalue},FileFinder)

IsPathSet((FileFinder)arg1) → bool :

C++ signature :

bool IsPathSet(FileFinder {lvalue})

Remove((FileFinder)arg1) → None :

C++ signature :

void Remove(FileFinder {lvalue})

static ReplaceSpacesWithUnderscores((str)rPath) → None :

C++ signature :

void ReplaceSpacesWithUnderscores(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > {lvalue})

static ReplaceUnderscoresWithSpaces((str)rPath) → None :

C++ signature :

void ReplaceUnderscoresWithSpaces(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > {lvalue})

SetPath((FileFinder)arg1, (str)rPath, (Value)relativeTo) → None :

C++ signature :

void SetPath(FileFinder {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,RelativeTo::Value)

SetPath( (FileFinder)arg1, (str)rPath, (Value)relativeTo) -> None :

C++ signature :

void SetPath(FileFinder_wrapper {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,RelativeTo::Value)

SetPath( (FileFinder)arg1, (str)rLeafName, (FileFinder)rParentOrSibling) -> None :

C++ signature :

void SetPath(FileFinder {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,FileFinder)

SetPath( (FileFinder)arg1, (str)rLeafName, (FileFinder)rParentOrSibling) -> None :

C++ signature :

void SetPath(FileFinder_wrapper {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >,FileFinder)

static StopFaking() → None :

C++ signature :

void StopFaking()

class chaste.core.RandomNumberGenerator

static Destroy() → None :

C++ signature :

void Destroy()

ExponentialRandomDeviate((RandomNumberGenerator)arg1, (float)scale) → float :

C++ signature :

double ExponentialRandomDeviate(RandomNumberGenerator {lvalue},double)

GammaRandomDeviate((RandomNumberGenerator)arg1, (float)shape, (float)scale) → float :

C++ signature :

double GammaRandomDeviate(RandomNumberGenerator {lvalue},double,double)

static Instance() → RandomNumberGenerator :

C++ signature :

RandomNumberGenerator* Instance()

NormalRandomDeviate((RandomNumberGenerator)arg1, (float)mean, (float)stdDev) → float :

C++ signature :

double NormalRandomDeviate(RandomNumberGenerator {lvalue},double,double)

Reseed((RandomNumberGenerator)arg1, (int)seed) → None :

C++ signature :

void Reseed(RandomNumberGenerator {lvalue},unsigned int)

Shuffle((RandomNumberGenerator)arg1, (int)num, (VecUnsigned)rValues) → None :

C++ signature :

void Shuffle(RandomNumberGenerator {lvalue},unsigned int,std::vector<unsigned int, std::allocator<unsigned int> > {lvalue})

StandardNormalRandomDeviate((RandomNumberGenerator)arg1) → float :

C++ signature :

double StandardNormalRandomDeviate(RandomNumberGenerator {lvalue})

randMod((RandomNumberGenerator)arg1, (int)base) → int :

C++ signature :

unsigned int randMod(RandomNumberGenerator {lvalue},unsigned int)

ranf((RandomNumberGenerator)arg1) → float :

C++ signature :

double ranf(RandomNumberGenerator {lvalue})

class chaste.core.Timer

static GetElapsedTime() → float :

C++ signature :

double GetElapsedTime()

static GetWallTime() → float :

C++ signature :

double GetWallTime()

static Print((str)message) → None :

C++ signature :

void Print(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

static PrintAndReset((str)message) → None :

C++ signature :

void PrintAndReset(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

static Reset() → None :

C++ signature :

void Reset()

class chaste.core.ChasteBuildInfo

static GetBuildInformation() → str :

C++ signature :

char const* GetBuildInformation()

static GetBuildTime() → str :

C++ signature :

char const* GetBuildTime()

static GetBuilderUnameInfo() → str :

C++ signature :

char const* GetBuilderUnameInfo()

static GetCompilerFlags() → str :

C++ signature :

char const* GetCompilerFlags()

static GetCompilerType() → str :

C++ signature :

char const* GetCompilerType()

static GetCompilerVersion() → str :

C++ signature :

char const* GetCompilerVersion()

static GetCurrentTime() → str :

C++ signature :

char const* GetCurrentTime()

static GetLicenceText() → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetLicenceText()

static GetMajorReleaseNumber() → int :

C++ signature :

unsigned int GetMajorReleaseNumber()

static GetMinorReleaseNumber() → int :

C++ signature :

unsigned int GetMinorReleaseNumber()

static GetProvenanceString() → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetProvenanceString()

static GetRevisionNumber() → int :

C++ signature :

unsigned int GetRevisionNumber()

static GetRootDir() → str :

C++ signature :

char const* GetRootDir()

static GetVersionString() → str :

C++ signature :

std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > GetVersionString()

static GetXsdVersion() → str :

C++ signature :

char const* GetXsdVersion()

static IsWorkingCopyModified() → bool :

C++ signature :

bool IsWorkingCopyModified()

static rGetProjectVersions() → MapString :

C++ signature :

std::map<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::less<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::pair<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > > > rGetProjectVersions()

class chaste.core.PetscTools

static AmMaster() → bool :

C++ signature :

bool AmMaster()

static AmTopMost() → bool :

C++ signature :

bool AmTopMost()

static Barrier([(str)callerId='']) → None :

C++ signature :

void Barrier([ std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >=’‘])

static BeginRoundRobin() → None :

C++ signature :

void BeginRoundRobin()

static CreateAndSetVec((int)size, (float)value) → _p_Vec* :

C++ signature :

_p_Vec* CreateAndSetVec(int,double)

static CreateVec((int)size[, (int)localSize=-1[, (bool)ignoreOffProcEntries=True]]) → _p_Vec* :

C++ signature :

_p_Vec* CreateVec(int [,int=-1 [,bool=True]])

CreateVec( (VecDouble)data) -> _p_Vec* :

C++ signature :

_p_Vec* CreateVec(std::vector<double, std::allocator<double> >)

static Destroy((_p_Vec*)rVec) → None :

C++ signature :

void Destroy(_p_Vec* {lvalue})

Destroy( (_p_Mat*)rMat) -> None :

C++ signature :

void Destroy(_p_Mat* {lvalue})

static DumpPetscObject((_p_Mat*)rMat, (str)rOutputFileFullPath) → None :

C++ signature :

void DumpPetscObject(_p_Mat*,std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

DumpPetscObject( (_p_Vec*)rVec, (str)rOutputFileFullPath) -> None :

C++ signature :

void DumpPetscObject(_p_Vec*,std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

static EndRoundRobin() → None :

C++ signature :

void EndRoundRobin()

static GetMyRank() → int :

C++ signature :

unsigned int GetMyRank()

static GetNumProcs() → int :

C++ signature :

unsigned int GetNumProcs()

static HasParMetis() → bool :

C++ signature :

bool HasParMetis()

static IsInitialised() → bool :

C++ signature :

bool IsInitialised()

static IsIsolated() → bool :

C++ signature :

bool IsIsolated()

static IsParallel() → bool :

C++ signature :

bool IsParallel()

static IsSequential() → bool :

C++ signature :

bool IsSequential()

static IsolateProcesses([(bool)isolate=True]) → None :

C++ signature :

void IsolateProcesses([ bool=True])

static ReadPetscObject((_p_Mat*)rMat, (str)rOutputFileFullPath[, (_p_Vec*)rParallelLayout=0]) → None :

C++ signature :

void ReadPetscObject(_p_Mat* {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > [,_p_Vec*=0])

ReadPetscObject( (_p_Vec*)rVec, (str)rOutputFileFullPath [, (_p_Vec*)rParallelLayout=0]) -> None :

C++ signature :

void ReadPetscObject(_p_Vec* {lvalue},std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > [,_p_Vec*=0])

static ReplicateBool((bool)flag) → bool :

C++ signature :

bool ReplicateBool(bool)

static ReplicateException((bool)flag) → None :

C++ signature :

void ReplicateException(bool)

static ResetCache() → None :

C++ signature :

void ResetCache()

static SetOption((str)pOptionName, (str)pOptionValue) → None :

C++ signature :

void SetOption(char const*,char const*)

static SetupMat((_p_Mat*)rMat, (int)numRows, (int)numColumns, (int)rowPreallocation[, (int)numLocalRows=-1[, (int)numLocalColumns=-1[, (bool)ignoreOffProcEntries=True[, (bool)newAllocationError=True]]]]) → None :

C++ signature :

void SetupMat(_p_Mat* {lvalue},int,int,unsigned int [,int=-1 [,int=-1 [,bool=True [,bool=True]]]])

class chaste.core.ReplicatableVector

GetSize((ReplicatableVector)arg1) → int :

C++ signature :

unsigned int GetSize(ReplicatableVector {lvalue})

Replicate((ReplicatableVector)arg1, (int)lo, (int)hi) → None :

C++ signature :

void Replicate(ReplicatableVector {lvalue},unsigned int,unsigned int)

ReplicatePetscVector((ReplicatableVector)arg1, (_p_Vec*)vec) → None :

C++ signature :

void ReplicatePetscVector(ReplicatableVector {lvalue},_p_Vec*)

Resize((ReplicatableVector)arg1, (int)size) → None :

C++ signature :

void Resize(ReplicatableVector {lvalue},unsigned int)