FibreWriter< DIM > Class Template Reference
#include <FibreWriter.hpp>
Public Member Functions | |
| FibreWriter (const std::string &rDirectory, const std::string &rBaseName, const bool clearOutputDir=true) | |
| ~FibreWriter () | |
| void | WriteAllAxi (const std::vector< c_vector< double, DIM > > &direction) |
| void | SetWriteFileAsBinary () |
Private Attributes | |
| OutputFileHandler * | mpOutputFileHandler |
| std::string | mBaseName |
| bool | mFileIsBinary |
Detailed Description
template<unsigned DIM>
class FibreWriter< DIM >
A class for writing .axi files (files which define the fibre direction for each element) and .ortho files (files which define the fibre, sheet and normal directions for each element.
Definition at line 46 of file FibreWriter.hpp.
Constructor & Destructor Documentation
| FibreWriter< DIM >::FibreWriter | ( | const std::string & | rDirectory, | |
| const std::string & | rBaseName, | |||
| const bool | clearOutputDir = true | |||
| ) | [inline] |
Create a new FibreWriter.
- Parameters:
-
rDirectory the directory in which to write the fibre to file rBaseName the base name of the files in which to write the fibre data clearOutputDir whether to clean the directory (defaults to true)
Definition at line 33 of file FibreWriter.cpp.
References FibreWriter< DIM >::mpOutputFileHandler.
| FibreWriter< DIM >::~FibreWriter | ( | ) | [inline] |
Destructor closes file.
Definition at line 43 of file FibreWriter.cpp.
References FibreWriter< DIM >::mpOutputFileHandler.
Member Function Documentation
| void FibreWriter< DIM >::WriteAllAxi | ( | const std::vector< c_vector< double, DIM > > & | direction | ) | [inline] |
Writes all axisymmetric vectors to the file.
- Parameters:
-
direction an vector of fibre direction vectors
Definition at line 49 of file FibreWriter.cpp.
References ChasteBuildInfo::GetProvenanceString(), FibreWriter< DIM >::mBaseName, FibreWriter< DIM >::mpOutputFileHandler, and OutputFileHandler::OpenOutputFile().
| void FibreWriter< DIM >::SetWriteFileAsBinary | ( | ) | [inline] |
Switch to write binary fibre file
(set to write ascii files in the constructor)
Definition at line 80 of file FibreWriter.cpp.
References FibreWriter< DIM >::mFileIsBinary.
Member Data Documentation
OutputFileHandler* FibreWriter< DIM >::mpOutputFileHandler [private] |
Output file handler
Definition at line 49 of file FibreWriter.hpp.
Referenced by FibreWriter< DIM >::FibreWriter(), FibreWriter< DIM >::WriteAllAxi(), and FibreWriter< DIM >::~FibreWriter().
std::string FibreWriter< DIM >::mBaseName [private] |
Base name for the input files
Definition at line 51 of file FibreWriter.hpp.
Referenced by FibreWriter< DIM >::WriteAllAxi().
bool FibreWriter< DIM >::mFileIsBinary [private] |
Whether all data is to be written as binary
Definition at line 52 of file FibreWriter.hpp.
Referenced by FibreWriter< DIM >::SetWriteFileAsBinary().
The documentation for this class was generated from the following files:
- heart/src/io/FibreWriter.hpp
- heart/src/io/FibreWriter.cpp
