AbstractConductivityTensors.hpp

00001 /*
00002 
00003 Copyright (c) 2005-2015, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 #ifndef ABSTRACTCONDUCTIVITYTENSORS_HPP_
00036 #define ABSTRACTCONDUCTIVITYTENSORS_HPP_
00037 
00038 #include <vector>
00039 #include <string>
00040 #include <memory>
00041 #include "UblasIncludes.hpp"
00042 #include "AbstractTetrahedralMesh.hpp"
00043 #include "FibreReader.hpp"
00044 #include "Exception.hpp"
00045 #include "FileFinder.hpp"
00046 
00050 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
00051 class AbstractConductivityTensors
00052 {
00053 protected:
00054     AbstractTetrahedralMesh<ELEMENT_DIM, SPACE_DIM>* mpMesh; 
00055     bool mUseNonConstantConductivities; 
00056     bool mUseFibreOrientation; 
00059     c_vector<double, SPACE_DIM> mConstantConductivities; // mS/cm
00060 
00065     std::vector<c_vector<double, SPACE_DIM> >* mpNonConstantConductivities; // mS/cm
00066 
00069     std::vector< c_matrix<double,SPACE_DIM,SPACE_DIM> > mTensors;
00070 
00072     bool mInitialised;
00073 
00075     FileFinder mFibreOrientationFile;
00076 
00078     std::auto_ptr<FibreReader<SPACE_DIM> > mFileReader;
00079 
00080 public:
00081 
00082     AbstractConductivityTensors();
00083 
00084     virtual ~AbstractConductivityTensors();
00085 
00091     void SetFibreOrientationFile(const FileFinder &rFibreOrientationFile);
00092 
00100     void SetConstantConductivities(c_vector<double, 1> constantConductivities);
00101 
00109     void SetConstantConductivities(c_vector<double, 2> constantConductivities);
00110 
00118     virtual void SetConstantConductivities(c_vector<double, 3> constantConductivities);
00119 
00120 
00125     void SetNonConstantConductivities(std::vector<c_vector<double, SPACE_DIM> >* pNonConstantConductivities);
00126 
00131     virtual void Init(AbstractTetrahedralMesh<ELEMENT_DIM, SPACE_DIM> *pMesh) throw (Exception) = 0;
00132 
00138     c_matrix<double,SPACE_DIM,SPACE_DIM>& operator[](const unsigned global_index);
00139 };
00140 
00141 
00142 
00143 #endif /*ABSTRACTCONDUCTIVITYTENSORS_HPP_*/