![]() |
Chaste Commit::333233612e3dcc941d260418acd7b5ccdc30390e
|
#include <ArchiveLocationInfo.hpp>
Static Public Member Functions | |
static void | SetMeshPathname (const FileFinder &rDirectory, const std::string &rFilename) |
static void | SetMeshPathname (const std::string &rDirectory, const std::string &rFilename) |
static void | SetMeshFilename (const std::string &rFilename) |
static std::string | GetMeshFilename () |
static std::string | GetArchiveDirectory () |
static std::string | GetProcessUniqueFilePath (const std::string &rFileName, unsigned procId=PetscTools::GetMyRank()) |
static void | SetArchiveDirectory (const FileFinder &rDirectory) |
static std::string | GetArchiveRelativePath () |
static bool | GetIsDirRelativeToChasteTestOutput () |
Static Private Attributes | |
static std::string | mDirAbsPath = "" |
static std::string | mMeshFilename = "mesh" |
Mini-class to help with 'archiving' various classes that don't write their data directly to the archive file. They thus need to know information about where the archive is being written to, in order to write their own files into the same folder. The main methods are GetArchiveDirectory and SetArchiveDirectory.
This functionality is used by the meshes, LinearSystem and HeartConfig.
For the benefit of the meshes (and the cell_based code), there are also shortcut methods SetMeshPathname and GetMeshFilename, allowing you to specify the base file name for the mesh. This is needed because the cell_based code adds timestamp information to the file name.
Definition at line 57 of file ArchiveLocationInfo.hpp.
|
static |
Get the directory that archives are being written to. Will always end in a '/'.
Definition at line 83 of file ArchiveLocationInfo.cpp.
References EXCEPTION, and mDirAbsPath.
Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), ArchiveOpener< Archive, Stream >::ArchiveOpener(), GetProcessUniqueFilePath(), PottsMesh< DIM >::load(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::load(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::load(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::load(), HeartConfig::LoadFromCheckpoint(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::save(), and HeartConfig::Write().
|
static |
Get the directory to which the archives are being written. Remove CHASTE_TEST_OUTPUT prefix (assuming it exists); if it doesn't, returns the absolute path. Will always end in a '/'.
Definition at line 110 of file ArchiveLocationInfo.cpp.
References OutputFileHandler::GetChasteTestOutputDirectory(), and mDirAbsPath.
Referenced by ArchiveOpener< Archive, Stream >::ArchiveOpener(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::load(), ExtendedBidomainProblem< DIM >::load(), PottsMesh< DIM >::save(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::save(), ExtendedBidomainProblem< DIM >::save(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::save(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::save(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::save(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::save().
|
static |
Definition at line 126 of file ArchiveLocationInfo.cpp.
References OutputFileHandler::GetChasteTestOutputDirectory(), and mDirAbsPath.
Referenced by ArchiveOpener< Archive, Stream >::ArchiveOpener().
|
static |
Get the filename that the mesh should be written to
Definition at line 74 of file ArchiveLocationInfo.cpp.
References EXCEPTION, and mMeshFilename.
Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), PottsMesh< DIM >::load(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::load(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::load(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::load(), PottsMesh< DIM >::save(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::save(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::save(), ImmersedBoundaryMesh< ELEMENT_DIM, SPACE_DIM >::save(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::save().
|
static |
Get the full path to an output file which has a name unique to the current process. Useful for ensuring that each process writes to / reads from a separate file when running in parallel.
The path will have the form "path_to_output_dir/rFileName.process_rank"
rFileName | the base file name |
procId | the process id number (defaults to current process) |
Definition at line 92 of file ArchiveLocationInfo.cpp.
References GetArchiveDirectory().
Referenced by ArchiveOpener< Archive, Stream >::ArchiveOpener(), and CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate().
|
static |
Set the directory that archives are being written to.
rDirectory | the directory in question. |
Definition at line 101 of file ArchiveLocationInfo.cpp.
References FileFinder::GetAbsolutePath(), and mDirAbsPath.
Referenced by ArchiveOpener< Archive, Stream >::ArchiveOpener(), OutputFileHandler::SetArchiveDirectory(), SetMeshPathname(), and SetMeshPathname().
|
static |
Set the filename for mesh files.
rFilename | the base name (minus extension) for the mesh files, used to put on a timestamp. |
Definition at line 69 of file ArchiveLocationInfo.cpp.
References mMeshFilename.
Referenced by CellBasedSimulationArchiver< ELEMENT_DIM, SIM, SPACE_DIM >::Save().
|
static |
Set the location to write mesh files.
rDirectory | the directory to write to. |
rFilename | the base name (minus extension) for the mesh files. |
Definition at line 46 of file ArchiveLocationInfo.cpp.
References mMeshFilename, and SetArchiveDirectory().
Referenced by CellBasedSimulationArchiver< ELEMENT_DIM, SIM, SPACE_DIM >::Load().
|
static |
Set the location to write mesh files.
rDirectory | the directory to write to (if relative, assumes relative to CHASTE_TEST_OUTPUT). |
rFilename | the base name (minus extension) for the mesh files. |
Definition at line 52 of file ArchiveLocationInfo.cpp.
References RelativeTo::Absolute, RelativeTo::ChasteTestOutput, FileFinder::IsAbsolutePath(), mMeshFilename, and SetArchiveDirectory().
|
staticprivate |
Absolute path for directory that archives are being written to.
Definition at line 62 of file ArchiveLocationInfo.hpp.
Referenced by GetArchiveDirectory(), GetArchiveRelativePath(), GetIsDirRelativeToChasteTestOutput(), and SetArchiveDirectory().
|
staticprivate |
Mesh filename (relative to mDirAbsPath).
Definition at line 65 of file ArchiveLocationInfo.hpp.
Referenced by GetMeshFilename(), SetMeshFilename(), SetMeshPathname(), and SetMeshPathname().