40#include "AbstractChasteRegion.hpp"
41#include "ArchiveLocationInfo.hpp"
42#include "ChastePoint.hpp"
43#include "ChasteXsdVersion.hpp"
45#include "FilesystemPermissions.hpp"
46#include "HeartConfig.hpp"
47#include "HeartFileFinder.hpp"
48#include "OutputFileHandler.hpp"
50#include "Warnings.hpp"
52#include "HeartRegionCodes.hpp"
54#include "RegularStimulus.hpp"
55#include "SimpleStimulus.hpp"
63#include <xsd/cxx/tree/exceptions.hxx>
64#include "XmlTools.hpp"
65using namespace xsd::cxx::tree;
68#if CHASTE_XSD_VERSION_AT_LEAST(3, 0, 0)
69#define XSD_SEQUENCE_TYPE(base) base##_sequence
70#define XSD_ITERATOR_TYPE(base) base##_iterator
71#define XSD_NESTED_TYPE(t) t##_type
72#define XSD_ANON_TYPE(t1, t2) \
75#define XSD_SEQUENCE_TYPE(base) base::container
76#define XSD_ITERATOR_TYPE(base) base::iterator
77#define XSD_NESTED_TYPE(t) t::type
78#define XSD_ANON_TYPE(t1, t2) \
79 t1::t2::_xsd_##t2##_::t2
83#define XSD_ANON_SEQUENCE_TYPE(t1, t2, t3) \
84 XSD_SEQUENCE_TYPE(XSD_ANON_TYPE(t1, t2)::t3)
85#define XSD_ANON_ITERATOR_TYPE(t1, t2, t3) \
86 XSD_ITERATOR_TYPE(XSD_ANON_TYPE(t1, t2)::t3)
89#if CHASTE_XSD_VERSION_AT_LEAST(3, 2, 0)
90#define XSD_CREATE_WITH_FIXED_ATTR(type, name, attr) \
92#define XSD_CREATE_WITH_FIXED_ATTR1(type, name, arg1, attr) \
94#define XSD_CREATE_WITH_FIXED_ATTR2(type, name, arg1, arg2, attr) \
96#define XSD_CREATE_WITH_FIXED_ATTR3(type, name, arg1, arg2, arg3, attr) \
97 type name(arg1, arg2, arg3)
99#define XSD_CREATE_WITH_FIXED_ATTR(type, name, attr) \
101#define XSD_CREATE_WITH_FIXED_ATTR1(type, name, arg1, attr) \
102 type name(arg1, attr)
103#define XSD_CREATE_WITH_FIXED_ATTR2(type, name, arg1, arg2, attr) \
104 type name(arg1, arg2, attr)
105#define XSD_CREATE_WITH_FIXED_ATTR3(type, name, arg1, arg2, arg3, attr) \
106 type name(arg1, arg2, arg3, attr)
112#define ENSURE_SECTION_PRESENT(location, type) \
113 if (!location.present()) \
116 location.set(empty_item); \
119#include <boost/current_function.hpp>
127#define CHECK_EXISTS(test, path) \
132 EXCEPTION("No XML element " << path << " found in parameters when calling '" \
133 << BOOST_CURRENT_FUNCTION << "'"); \
152 xercesc::DOMElement* pRootElement);
163 xercesc::DOMElement* pRootElement);
173 xercesc::DOMElement* pRootElement);
183 xercesc::DOMElement* pRootElement);
193 xercesc::DOMElement* pRootElement);
220 : mUseMassLumping(false),
221 mUseMassLumpingForPrecond(false),
222 mUseFixedNumberIterations(false),
223 mEvaluateNumItsEveryNSolves(UINT_MAX)
258 std::string output_dirname;
259 if (useArchiveLocationInfo)
278 out_stream p_parameters_file(
new std::ofstream((output_dirname +
"ChasteParameters.xml").c_str()));
280 if (!p_parameters_file->is_open())
282 EXCEPTION(
"Could not open XML file in HeartConfig");
288 ::xml_schema::namespace_infomap map;
290 map[
""].schema =
"ChasteParameters_1_1.xsd";
292 map[
"cp20"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_0";
293 map[
"cp20"].schema =
"ChasteParameters_2_0.xsd";
294 map[
"cp21"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_1";
295 map[
"cp21"].schema =
"ChasteParameters_2_1.xsd";
296 map[
"cp22"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_2";
297 map[
"cp22"].schema =
"ChasteParameters_2_2.xsd";
298 map[
"cp23"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_3";
299 map[
"cp23"].schema =
"ChasteParameters_2_3.xsd";
300 map[
"cp30"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_0";
301 map[
"cp30"].schema =
"ChasteParameters_3_0.xsd";
302 map[
"cp31"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_1";
303 map[
"cp31"].schema =
"ChasteParameters_3_1.xsd";
304 map[
"cp33"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_3";
305 map[
"cp33"].schema =
"ChasteParameters_3_3.xsd";
306 map[
"cp34"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_4";
307 map[
"cp34"].schema =
"ChasteParameters_3_4.xsd";
310 map[
"cp"].name =
"https://chaste.comlab.ox.ac.uk/nss/parameters/2017_1";
311 map[
"cp"].schema =
"ChasteParameters_2017_1.xsd";
313 cp::ChasteParameters(*p_parameters_file, *
mpParameters, map);
316 if (useArchiveLocationInfo)
334 boost::shared_ptr<cp::chaste_parameters_type> p_new_parameters =
mpParameters;
350 if (
FileFinder(defaults_filename_xml).Exists())
352 boost::shared_ptr<cp::chaste_parameters_type> p_defaults =
ReadFile(defaults_filename_xml);
359 if (p_new_parameters->ResumeSimulation().present())
373 std::string schema_name(
"ChasteParameters_2017_1.xsd");
375 if (!schema_location.
Exists())
379 if (!schema_location.
Exists())
382 std::string message(
"Unable to locate schema file " + schema_name +
". You will need to ensure it is available when resuming from the checkpoint.");
383 WARN_ONCE_ONLY(message);
386 if (schema_location.
Exists())
389 schema_location.
CopyTo(output_directory);
401 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_0"] = root_dir +
"ChasteParameters_2_0.xsd";
402 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_1"] = root_dir +
"ChasteParameters_2_1.xsd";
403 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_2"] = root_dir +
"ChasteParameters_2_2.xsd";
404 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/2_3"] = root_dir +
"ChasteParameters_2_3.xsd";
405 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_0"] = root_dir +
"ChasteParameters_3_0.xsd";
406 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_1"] = root_dir +
"ChasteParameters_3_1.xsd";
407 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_3"] = root_dir +
"ChasteParameters_3_3.xsd";
408 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_4"] = root_dir +
"ChasteParameters_3_4.xsd";
409 mSchemaLocations[
"https://chaste.comlab.ox.ac.uk/nss/parameters/2017_1"] = root_dir +
"ChasteParameters_2017_1.xsd";
414 unsigned version_major = 0;
415 unsigned version_minor = 0;
416 if (rNamespaceUri ==
"")
423 std::string uri_base(
"https://chaste.comlab.ox.ac.uk/nss/parameters/");
424 if (rNamespaceUri.substr(0, uri_base.length()) == uri_base)
426 std::istringstream version_string(rNamespaceUri.substr(uri_base.length()));
427 version_string >> version_major;
428 version_string.ignore(1);
429 version_string >> version_minor;
430 if (version_string.fail())
438 unsigned version = version_major * 1000 + version_minor;
441 EXCEPTION(rNamespaceUri +
" is not a recognised Chaste parameters namespace.");
460 ::xml_schema::properties props;
487 xercesc::DOMElement* p_root_elt = p_doc->getDocumentElement();
488 std::string namespace_uri(X2C(p_root_elt->getNamespaceURI()));
511 if (version < 2017001)
516 boost::shared_ptr<cp::chaste_parameters_type> p_params(cp::ChasteParameters(*p_doc, ::xml_schema::flags::dont_initialize, props));
520 return boost::shared_ptr<cp::chaste_parameters_type>(p_params);
522 catch (
const xml_schema::exception& e)
524 std::cerr << e << std::endl;
527 EXCEPTION(
"XML parsing error in configuration file: " + rFileName);
560 EXCEPTION(
"Problem type and space dimension should match when restarting a simulation.");
567 if (pResumeParameters->ResumeSimulation()->Stimuli().present())
569 mpParameters->Simulation()->Stimuli().set(pResumeParameters->ResumeSimulation()->Stimuli().get());
574 if (pResumeParameters->ResumeSimulation()->CellHeterogeneities().present())
576 if (!
mpParameters->Simulation()->CellHeterogeneities().present())
579 mpParameters->Simulation()->CellHeterogeneities().set(pResumeParameters->ResumeSimulation()->CellHeterogeneities().get());
584 XSD_SEQUENCE_TYPE(cp::cell_heterogeneities_type::CellHeterogeneity)& new_seq = pResumeParameters->ResumeSimulation()->CellHeterogeneities()->CellHeterogeneity();
585 XSD_SEQUENCE_TYPE(cp::cell_heterogeneities_type::CellHeterogeneity)& orig_seq =
mpParameters->Simulation()->CellHeterogeneities()->CellHeterogeneity();
586 for (XSD_ITERATOR_TYPE(cp::cell_heterogeneities_type::CellHeterogeneity) i = new_seq.begin();
590 orig_seq.push_back(*i);
596 if (pResumeParameters->ResumeSimulation()->CheckpointSimulation().present())
599 pResumeParameters->ResumeSimulation()->CheckpointSimulation()->timestep(),
600 pResumeParameters->ResumeSimulation()->CheckpointSimulation()->max_checkpoints_on_disk());
604 if (pResumeParameters->ResumeSimulation()->OutputVisualizer().present())
614 cp::numerical_type& r_resume = pResumeParameters->Numerical();
616 if (r_resume.TimeSteps().present())
618 r_user.TimeSteps().set(r_resume.TimeSteps().get());
620 if (r_resume.KSPTolerances().present())
622 r_user.KSPTolerances().set(r_resume.KSPTolerances().get());
624 if (r_resume.KSPSolver().present())
626 r_user.KSPSolver().set(r_resume.KSPSolver().get());
628 if (r_resume.KSPPreconditioner().present())
630 r_user.KSPPreconditioner().set(r_resume.KSPPreconditioner().get());
632 if (r_resume.AdaptivityParameters().present())
634 r_user.AdaptivityParameters().set(r_resume.AdaptivityParameters().get());
639 if (pResumeParameters->PostProcessing().present())
642 cp::postprocessing_type& r_resume = pResumeParameters->PostProcessing().get();
643 cp::postprocessing_type& r_user =
mpParameters->PostProcessing().get();
644 if (!r_resume.ActionPotentialDurationMap().empty())
646 r_user.ActionPotentialDurationMap() = r_resume.ActionPotentialDurationMap();
648 if (!r_resume.UpstrokeTimeMap().empty())
650 r_user.UpstrokeTimeMap() = r_resume.UpstrokeTimeMap();
652 if (!r_resume.MaxUpstrokeVelocityMap().empty())
654 r_user.MaxUpstrokeVelocityMap() = r_resume.MaxUpstrokeVelocityMap();
656 if (!r_resume.ConductionVelocityMap().empty())
658 r_user.ConductionVelocityMap() = r_resume.ConductionVelocityMap();
660 if (!r_resume.PseudoEcgElectrodePosition().empty())
662 r_user.PseudoEcgElectrodePosition() = r_resume.PseudoEcgElectrodePosition();
689 EXCEPTION(callingMethod +
" information is not available in a resumed simulation.");
697 EXCEPTION(callingMethod +
" information is not available in a standard (non-resumed) simulation.");
705 CHECK_EXISTS(
mpParameters->Simulation()->SpaceDimension().present(),
"Simulation/SpaceDimension");
706 return mpParameters->Simulation()->SpaceDimension().get();
710 return mpParameters->ResumeSimulation()->SpaceDimension();
718 CHECK_EXISTS(
mpParameters->Simulation()->SimulationDuration().present(),
"Simulation/SimulationDuration");
719 return mpParameters->Simulation()->SimulationDuration().get();
723 return mpParameters->ResumeSimulation()->SimulationDuration();
731 CHECK_EXISTS(
mpParameters->Simulation()->Domain().present(),
"Simulation/Domain");
744 return mpParameters->Simulation()->IonicModels()->Default();
747template <
unsigned DIM>
749 std::vector<cp::ionic_model_selection_type>& ionicModels)
const
752 definedRegions.clear();
755 XSD_SEQUENCE_TYPE(cp::ionic_models_type::Region)& regions =
mpParameters->Simulation()->IonicModels()->Region();
757 for (XSD_ITERATOR_TYPE(cp::ionic_models_type::Region) i = regions.begin();
761 cp::ionic_model_region_type ionic_model_region(*i);
763 if (ionic_model_region.Location().Cuboid().present() || ionic_model_region.Location().Ellipsoid().present())
765 if (ionic_model_region.Location().Cuboid().present())
767 cp::point_type point_a = ionic_model_region.Location().Cuboid()->LowerCoordinates();
768 cp::point_type point_b = ionic_model_region.Location().Cuboid()->UpperCoordinates();
798 else if (ionic_model_region.Location().Ellipsoid().present())
800 cp::point_type centre = ionic_model_region.Location().Ellipsoid()->Centre();
801 cp::point_type radii = ionic_model_region.Location().Ellipsoid()->Radii();
837 ionicModels.push_back(ionic_model_region.IonicModel());
839 else if (ionic_model_region.Location().EpiLayer().present() || ionic_model_region.Location().MidLayer().present() || ionic_model_region.Location().EndoLayer().present())
842 EXCEPTION(
"Definition of transmural layers is not yet supported for defining different ionic models, please use cuboids instead");
846 EXCEPTION(
"Invalid region type for ionic model definition");
862 return (
mesh.Slab().present() ||
mesh.Sheet().present() ||
mesh.Fibre().present());
870 return (
mesh.Slab().present());
878 return (
mesh.Sheet().present());
886 return (
mesh.Fibre().present());
893 return (
mpParameters->Simulation()->Mesh()->LoadMesh().present());
902 EXCEPTION(
"Tissue slabs can only be defined in 3D");
905 optional<cp::slab_type, false> slab_dimensions =
mpParameters->Simulation()->Mesh()->Slab();
907 slabDimensions[0] = slab_dimensions->x();
908 slabDimensions[1] = slab_dimensions->y();
909 slabDimensions[2] = slab_dimensions->z();
918 EXCEPTION(
"Tissue sheets can only be defined in 2D");
921 optional<cp::sheet_type, false> sheet_dimensions =
mpParameters->Simulation()->Mesh()->Sheet();
923 sheetDimensions[0] = sheet_dimensions->x();
924 sheetDimensions[1] = sheet_dimensions->y();
933 EXCEPTION(
"Tissue fibres can only be defined in 1D");
936 optional<cp::fibre_type, false> fibre_length =
mpParameters->Simulation()->Mesh()->Fibre();
938 fibreLength[0] = fibre_length->x();
949 return mpParameters->Simulation()->Mesh()->Slab()->inter_node_space();
953 return mpParameters->Simulation()->Mesh()->Sheet()->inter_node_space();
957 return mpParameters->Simulation()->Mesh()->Fibre()->inter_node_space();
972 return mpParameters->Simulation()->Mesh()->LoadMesh()->name();
980 return mpParameters->Simulation()->Mesh()->LoadMesh()->conductivity_media();
983template <
unsigned DIM>
996 XSD_SEQUENCE_TYPE(cp::stimuli_type::Stimulus)
997 stimuli =
mpParameters->Simulation()->Stimuli()->Stimulus();
999 for (XSD_ITERATOR_TYPE(cp::stimuli_type::Stimulus) i = stimuli.begin();
1003 cp::stimulus_type stimulus(*i);
1004 if (stimulus.Location().Cuboid().present() || stimulus.Location().Ellipsoid().present())
1006 boost::shared_ptr<AbstractChasteRegion<DIM> > area_ptr;
1007 if (stimulus.Location().Cuboid().present())
1009 cp::point_type point_a = stimulus.Location().Cuboid()->LowerCoordinates();
1010 cp::point_type point_b = stimulus.Location().Cuboid()->UpperCoordinates();
1039 else if (stimulus.Location().Ellipsoid().present())
1041 cp::point_type centre = stimulus.Location().Ellipsoid()->Centre();
1042 cp::point_type radii = stimulus.Location().Ellipsoid()->Radii();
1073 rStimulatedAreas.push_back(area_ptr);
1075 boost::shared_ptr<AbstractStimulusFunction> stim;
1077 if (stimulus.Period().present())
1079 if (stimulus.StopTime().present())
1082 stimulus.Duration(),
1083 stimulus.Period().get(),
1085 stimulus.StopTime().get()));
1090 stimulus.Duration(),
1091 stimulus.Period().get(),
1097 if (stimulus.StopTime().present())
1099 EXCEPTION(
"Stop time can not be defined for SimpleStimulus. Use Duration instead.");
1103 stimulus.Duration(),
1106 rStimuliApplied.push_back(stim);
1108 else if (stimulus.Location().EpiLayer().present() || stimulus.Location().MidLayer().present() || stimulus.Location().EndoLayer().present())
1110 EXCEPTION(
"Definition of transmural layers is not yet supported for specifying stimulated areas, please use cuboids instead");
1114 EXCEPTION(
"Invalid region type for stimulus definition");
1119template <
unsigned DIM>
1121 std::vector<double>& rScaleFactorGks,
1122 std::vector<double>& rScaleFactorIto,
1123 std::vector<double>& rScaleFactorGkr,
1124 std::vector<std::map<std::string, double> >* pParameterSettings)
1128 if (!
mpParameters->Simulation()->CellHeterogeneities().present())
1133 XSD_SEQUENCE_TYPE(cp::cell_heterogeneities_type::CellHeterogeneity)
1135 =
mpParameters->Simulation()->CellHeterogeneities()->CellHeterogeneity();
1137 bool user_supplied_negative_value =
false;
1139 bool user_asked_for_cuboids_or_ellipsoids =
false;
1140 unsigned counter_of_heterogeneities = 0;
1142 for (XSD_ITERATOR_TYPE(cp::cell_heterogeneities_type::CellHeterogeneity) i = cell_heterogeneity.begin();
1143 i != cell_heterogeneity.end();
1146 cp::cell_heterogeneity_type ht(*i);
1148 if (ht.Location().Cuboid().present())
1150 user_asked_for_cuboids_or_ellipsoids =
true;
1151 cp::point_type point_a = ht.Location().Cuboid()->LowerCoordinates();
1152 cp::point_type point_b = ht.Location().Cuboid()->UpperCoordinates();
1159 else if (ht.Location().Ellipsoid().present())
1161 user_asked_for_cuboids_or_ellipsoids =
true;
1162 cp::point_type centre = ht.Location().Ellipsoid()->Centre();
1163 cp::point_type radii = ht.Location().Ellipsoid()->Radii();
1169 else if (ht.Location().EpiLayer().present())
1176 user_supplied_negative_value =
true;
1180 else if (ht.Location().EndoLayer().present())
1187 user_supplied_negative_value =
true;
1191 else if (ht.Location().MidLayer().present())
1198 user_supplied_negative_value =
true;
1204 EXCEPTION(
"Invalid region type for cell heterogeneity definition");
1208 rScaleFactorGks.push_back(ht.ScaleFactorGks().present() ? (
double)ht.ScaleFactorGks().get() : 1.0);
1209 rScaleFactorIto.push_back(ht.ScaleFactorIto().present() ? (
double)ht.ScaleFactorIto().get() : 1.0);
1210 rScaleFactorGkr.push_back(ht.ScaleFactorGkr().present() ? (
double)ht.ScaleFactorGkr().get() : 1.0);
1213 if (pParameterSettings)
1215 std::map<std::string, double> param_settings;
1216 XSD_SEQUENCE_TYPE(cp::cell_heterogeneity_type::SetParameter)& params = ht.SetParameter();
1217 for (XSD_ITERATOR_TYPE(cp::cell_heterogeneity_type::SetParameter) param_it = params.begin();
1218 param_it != params.end();
1221 cp::set_parameter_type param(*param_it);
1222 param_settings[param.name()] = param.value();
1224 pParameterSettings->push_back(param_settings);
1227 counter_of_heterogeneities++;
1233 if (user_asked_for_cuboids_or_ellipsoids)
1235 EXCEPTION(
"Specification of cellular heterogeneities by cuboids/ellipsoids and layers at the same time is not yet supported");
1243 EXCEPTION(
"Three specifications of layers must be supplied");
1247 EXCEPTION(
"Summation of epicardial, midmyocardial and endocardial fractions should be 1");
1249 if (user_supplied_negative_value)
1251 EXCEPTION(
"Fractions must be positive");
1294 return mpParameters->Physiological().ConductivityHeterogeneities().present();
1297template <
unsigned DIM>
1300 std::vector<c_vector<double, 3> >& rIntraConductivities,
1301 std::vector<c_vector<double, 3> >& rExtraConductivities)
const
1305 XSD_ANON_SEQUENCE_TYPE(cp::physiological_type, ConductivityHeterogeneities, ConductivityHeterogeneity)& conductivity_heterogeneity =
mpParameters->Physiological().ConductivityHeterogeneities()->ConductivityHeterogeneity();
1307 for (XSD_ANON_ITERATOR_TYPE(cp::physiological_type, ConductivityHeterogeneities, ConductivityHeterogeneity) i = conductivity_heterogeneity.begin();
1308 i != conductivity_heterogeneity.end();
1311 cp::conductivity_heterogeneity_type ht(*i);
1313 if (ht.Location().Cuboid().present())
1315 cp::point_type point_a = ht.Location().Cuboid()->LowerCoordinates();
1316 cp::point_type point_b = ht.Location().Cuboid()->UpperCoordinates();
1321 else if (ht.Location().Ellipsoid().present())
1323 cp::point_type centre = ht.Location().Ellipsoid()->Centre();
1324 cp::point_type radii = ht.Location().Ellipsoid()->Radii();
1329 else if (ht.Location().EpiLayer().present() || ht.Location().MidLayer().present() || ht.Location().EndoLayer().present())
1332 EXCEPTION(
"Definition of transmural layers is not allowed for conductivities heterogeneities, you may use fibre orientation support instead");
1336 EXCEPTION(
"Invalid region type for conductivity definition");
1339 if (ht.IntracellularConductivities().present())
1341 double intra_x = ht.IntracellularConductivities()->longi();
1342 double intra_y = ht.IntracellularConductivities()->trans();
1343 double intra_z = ht.IntracellularConductivities()->normal();
1345 rIntraConductivities.push_back(Create_c_vector(intra_x, intra_y, intra_z));
1349 c_vector<double, 3> intra_conductivities;
1351 rIntraConductivities.push_back(intra_conductivities);
1354 if (ht.ExtracellularConductivities().present())
1356 double extra_x = ht.ExtracellularConductivities()->longi();
1357 double extra_y = ht.ExtracellularConductivities()->trans();
1358 double extra_z = ht.ExtracellularConductivities()->normal();
1360 rExtraConductivities.push_back(Create_c_vector(extra_x, extra_y, extra_z));
1364 c_vector<double, 3> extra_conductivities;
1366 rExtraConductivities.push_back(extra_conductivities);
1374 CHECK_EXISTS(
mpParameters->Simulation()->OutputDirectory().present(),
"Simulation/OutputDirectory");
1375 return mpParameters->Simulation()->OutputDirectory().get();
1381 CHECK_EXISTS(
mpParameters->Simulation()->OutputFilenamePrefix().present(),
"Simulation/OutputFilenamePrefix");
1382 return mpParameters->Simulation()->OutputFilenamePrefix().get();
1388 return mpParameters->Simulation()->OutputVariables().present();
1394 XSD_SEQUENCE_TYPE(cp::output_variables_type::Var)& output_variables =
mpParameters->Simulation()->OutputVariables()->Var();
1395 rOutputVariables.clear();
1397 for (XSD_ITERATOR_TYPE(cp::output_variables_type::Var) i = output_variables.begin();
1398 i != output_variables.end();
1401 cp::var_type& r_var(*i);
1404 rOutputVariables.push_back(r_var.name());
1411 bool result =
false;
1412 if (
mpParameters->Simulation()->OutputUsingOriginalNodeOrdering().present())
1414 result = (
mpParameters->Simulation()->OutputUsingOriginalNodeOrdering().get() == cp::yesno_type::yes);
1427 return mpParameters->Simulation()->CheckpointSimulation()->timestep();
1433 return mpParameters->Simulation()->CheckpointSimulation()->max_checkpoints_on_disk();
1445 CHECK_EXISTS(
mpParameters->Physiological().IntracellularConductivities().present(),
"Physiological/IntracellularConductivities");
1446 cp::conductivities_type intra_conductivities
1447 =
mpParameters->Physiological().IntracellularConductivities().get();
1448 double intra_x_cond = intra_conductivities.longi();
1449 double intra_y_cond = intra_conductivities.trans();
1450 double intra_z_cond = intra_conductivities.normal();
1453 assert(intra_y_cond != DBL_MAX);
1454 assert(intra_z_cond != DBL_MAX);
1456 rIntraConductivities[0] = intra_x_cond;
1457 rIntraConductivities[1] = intra_y_cond;
1458 rIntraConductivities[2] = intra_z_cond;
1463 CHECK_EXISTS(
mpParameters->Physiological().IntracellularConductivities().present(),
"Physiological/IntracellularConductivities");
1464 cp::conductivities_type intra_conductivities
1465 =
mpParameters->Physiological().IntracellularConductivities().get();
1466 double intra_x_cond = intra_conductivities.longi();
1467 double intra_y_cond = intra_conductivities.trans();
1469 assert(intra_y_cond != DBL_MAX);
1471 rIntraConductivities[0] = intra_x_cond;
1472 rIntraConductivities[1] = intra_y_cond;
1477 CHECK_EXISTS(
mpParameters->Physiological().IntracellularConductivities().present(),
"Physiological/IntracellularConductivities");
1478 cp::conductivities_type intra_conductivities
1479 =
mpParameters->Physiological().IntracellularConductivities().get();
1480 double intra_x_cond = intra_conductivities.longi();
1482 rIntraConductivities[0] = intra_x_cond;
1487 CHECK_EXISTS(
mpParameters->Physiological().ExtracellularConductivities().present(),
"Physiological/ExtracellularConductivities");
1488 cp::conductivities_type extra_conductivities
1489 =
mpParameters->Physiological().ExtracellularConductivities().get();
1490 double extra_x_cond = extra_conductivities.longi();
1491 double extra_y_cond = extra_conductivities.trans();
1492 double extra_z_cond = extra_conductivities.normal();
1495 assert(extra_y_cond != DBL_MAX);
1496 assert(extra_z_cond != DBL_MAX);
1498 rExtraConductivities[0] = extra_x_cond;
1499 rExtraConductivities[1] = extra_y_cond;
1500 rExtraConductivities[2] = extra_z_cond;
1505 CHECK_EXISTS(
mpParameters->Physiological().ExtracellularConductivities().present(),
"Physiological/ExtracellularConductivities");
1506 cp::conductivities_type extra_conductivities
1507 =
mpParameters->Physiological().ExtracellularConductivities().get();
1508 double extra_x_cond = extra_conductivities.longi();
1509 double extra_y_cond = extra_conductivities.trans();
1511 assert(extra_y_cond != DBL_MAX);
1513 rExtraConductivities[0] = extra_x_cond;
1514 rExtraConductivities[1] = extra_y_cond;
1519 CHECK_EXISTS(
mpParameters->Physiological().ExtracellularConductivities().present(),
"Physiological/ExtracellularConductivities");
1520 cp::conductivities_type extra_conductivities
1521 =
mpParameters->Physiological().ExtracellularConductivities().get();
1522 double extra_x_cond = extra_conductivities.longi();
1524 rExtraConductivities[0] = extra_x_cond;
1538 if (bathRegion == UINT_MAX)
1541 CHECK_EXISTS(
mpParameters->Physiological().BathConductivity().present(),
"Physiological/BathConductivity");
1542 return mpParameters->Physiological().BathConductivity().get();
1548 std::map<unsigned, double>::const_iterator map_entry =
mBathConductivities.find(bathRegion);
1552 return map_entry->second;
1557 CHECK_EXISTS(
mpParameters->Physiological().BathConductivity().present(),
"Physiological/BathConductivity");
1558 return mpParameters->Physiological().BathConductivity().get();
1574 CHECK_EXISTS(
mpParameters->Physiological().SurfaceAreaToVolumeRatio().present(),
"Physiological/SurfaceAreaToVolumeRatio");
1575 return mpParameters->Physiological().SurfaceAreaToVolumeRatio().get();
1580 CHECK_EXISTS(
mpParameters->Physiological().Capacitance().present(),
"Physiological/Capacitance");
1581 return mpParameters->Physiological().Capacitance().get();
1586 CHECK_EXISTS(
mpParameters->Numerical().TimeSteps().present(),
"Numerical/TimeSteps");
1592 CHECK_EXISTS(
mpParameters->Numerical().TimeSteps().present(),
"Numerical/TimeSteps");
1598 CHECK_EXISTS(
mpParameters->Numerical().TimeSteps().present(),
"Numerical/TimeSteps");
1599 return mpParameters->Numerical().TimeSteps()->printing();
1604 CHECK_EXISTS(
mpParameters->Numerical().KSPTolerances().present(),
"Numerical/KSPTolerances");
1605 return mpParameters->Numerical().KSPTolerances()->KSPAbsolute().present();
1610 CHECK_EXISTS(
mpParameters->Numerical().KSPTolerances().present(),
"Numerical/KSPTolerances");
1613 EXCEPTION(
"Absolute tolerance is not set in Chaste parameters");
1615 return mpParameters->Numerical().KSPTolerances()->KSPAbsolute().get();
1620 CHECK_EXISTS(
mpParameters->Numerical().KSPTolerances().present(),
"Numerical/KSPTolerances");
1621 return mpParameters->Numerical().KSPTolerances()->KSPRelative().present();
1626 CHECK_EXISTS(
mpParameters->Numerical().KSPTolerances().present(),
"Numerical/KSPTolerances");
1629 EXCEPTION(
"Relative tolerance is not set in Chaste parameters");
1631 return mpParameters->Numerical().KSPTolerances()->KSPRelative().get();
1636 CHECK_EXISTS(
mpParameters->Numerical().KSPSolver().present(),
"Numerical/KSPSolver");
1639 case cp::ksp_solver_type::gmres:
1641 case cp::ksp_solver_type::cg:
1643 case cp::ksp_solver_type::symmlq:
1645 case cp::ksp_solver_type::chebychev:
1655 CHECK_EXISTS(
mpParameters->Numerical().KSPPreconditioner().present(),
"Numerical/KSPPreconditioner");
1656 switch (
mpParameters->Numerical().KSPPreconditioner().get())
1658 case cp::ksp_preconditioner_type::jacobi:
1660 case cp::ksp_preconditioner_type::bjacobi:
1662 case cp::ksp_preconditioner_type::hypre:
1664 case cp::ksp_preconditioner_type::ml:
1666 case cp::ksp_preconditioner_type::spai:
1668 case cp::ksp_preconditioner_type::blockdiagonal:
1669 return "blockdiagonal";
1670 case cp::ksp_preconditioner_type::ldufactorisation:
1671 return "ldufactorisation";
1672 case cp::ksp_preconditioner_type::twolevelsblockdiagonal:
1673 return "twolevelsblockdiagonal";
1674 case cp::ksp_preconditioner_type::none:
1678 EXCEPTION(
"Unknown ksp preconditioner");
1684 CHECK_EXISTS(
mpParameters->Numerical().MeshPartitioning().present(),
"Numerical/MeshPartitioning");
1685 switch (
mpParameters->Numerical().MeshPartitioning().get())
1687 case cp::mesh_partitioning_type::dumb:
1688 return DistributedTetrahedralMeshPartitionType::DUMB;
1689 case cp::mesh_partitioning_type::metis:
1690 return DistributedTetrahedralMeshPartitionType::METIS_LIBRARY;
1691 case cp::mesh_partitioning_type::parmetis:
1692 return DistributedTetrahedralMeshPartitionType::PARMETIS_LIBRARY;
1693 case cp::mesh_partitioning_type::petsc:
1694 return DistributedTetrahedralMeshPartitionType::PETSC_MAT_PARTITION;
1697 EXCEPTION(
"Unknown mesh partitioning type");
1706 WARNING(
"Use of the Adaptivity library is deprecated");
1722 ENSURE_SECTION_PRESENT(
mpParameters->PostProcessing(), cp::postprocessing_type);
1738 bool result =
false;
1741 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ActionPotentialDurationMap)& apd_maps =
mpParameters->PostProcessing()->ActionPotentialDurationMap();
1742 result = (apd_maps.begin() != apd_maps.end());
1752 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ActionPotentialDurationMap)& apd_maps_sequence =
mpParameters->PostProcessing()->ActionPotentialDurationMap();
1754 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::ActionPotentialDurationMap) i = apd_maps_sequence.begin();
1755 i != apd_maps_sequence.end();
1758 std::pair<double, double> map(i->repolarisation_percentage(), i->threshold());
1760 apd_maps.push_back(map);
1766 bool result =
false;
1769 XSD_SEQUENCE_TYPE(cp::postprocessing_type::UpstrokeTimeMap)& upstroke_map =
mpParameters->PostProcessing()->UpstrokeTimeMap();
1770 result = (upstroke_map.begin() != upstroke_map.end());
1777 assert(upstroke_time_maps.size() == 0);
1779 XSD_SEQUENCE_TYPE(cp::postprocessing_type::UpstrokeTimeMap)& upstroke_maps_sequence =
mpParameters->PostProcessing()->UpstrokeTimeMap();
1781 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::UpstrokeTimeMap) i = upstroke_maps_sequence.begin();
1782 i != upstroke_maps_sequence.end();
1785 upstroke_time_maps.push_back(i->threshold());
1791 bool result =
false;
1794 XSD_SEQUENCE_TYPE(cp::postprocessing_type::MaxUpstrokeVelocityMap)& max_upstroke_velocity_map =
mpParameters->PostProcessing()->MaxUpstrokeVelocityMap();
1795 result = (max_upstroke_velocity_map.begin() != max_upstroke_velocity_map.end());
1803 assert(upstroke_velocity_maps.size() == 0);
1805 XSD_SEQUENCE_TYPE(cp::postprocessing_type::MaxUpstrokeVelocityMap)& max_upstroke_velocity_maps_sequence =
mpParameters->PostProcessing()->MaxUpstrokeVelocityMap();
1807 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::MaxUpstrokeVelocityMap) i = max_upstroke_velocity_maps_sequence.begin();
1808 i != max_upstroke_velocity_maps_sequence.end();
1811 upstroke_velocity_maps.push_back(i->threshold());
1817 bool result =
false;
1820 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ConductionVelocityMap)& cond_vel_maps =
mpParameters->PostProcessing()->ConductionVelocityMap();
1821 result = (cond_vel_maps.begin() != cond_vel_maps.end());
1829 assert(conduction_velocity_maps.size() == 0);
1831 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ConductionVelocityMap)& cond_vel_maps_sequence =
mpParameters->PostProcessing()->ConductionVelocityMap();
1833 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::ConductionVelocityMap) i = cond_vel_maps_sequence.begin();
1834 i != cond_vel_maps_sequence.end();
1837 conduction_velocity_maps.push_back(i->origin_node());
1843 bool result =
false;
1846 XSD_SEQUENCE_TYPE(cp::postprocessing_type::TimeTraceAtNode)& requested_nodes =
mpParameters->PostProcessing()->TimeTraceAtNode();
1847 result = (requested_nodes.begin() != requested_nodes.end());
1855 assert(rRequestedNodes.size() == 0);
1857 XSD_SEQUENCE_TYPE(cp::postprocessing_type::TimeTraceAtNode)& req_nodes =
mpParameters->PostProcessing()->TimeTraceAtNode();
1859 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::TimeTraceAtNode) i = req_nodes.begin();
1860 i != req_nodes.end();
1863 rRequestedNodes.push_back(i->node_number());
1869 bool result =
false;
1872 XSD_SEQUENCE_TYPE(cp::postprocessing_type::PseudoEcgElectrodePosition)& electrodes =
mpParameters->PostProcessing()->PseudoEcgElectrodePosition();
1873 result = (electrodes.begin() != electrodes.end());
1878template <
unsigned SPACE_DIM>
1881 rPseudoEcgElectrodePositions.clear();
1882 XSD_SEQUENCE_TYPE(cp::postprocessing_type::PseudoEcgElectrodePosition)& electrodes =
mpParameters->PostProcessing()->PseudoEcgElectrodePosition();
1883 for (XSD_ITERATOR_TYPE(cp::postprocessing_type::PseudoEcgElectrodePosition) i = electrodes.begin();
1884 i != electrodes.end();
1899 return mpParameters->Simulation()->OutputVisualizer().present();
1910 return mpParameters->Simulation()->OutputVisualizer()->meshalyzer() == cp::yesno_type::yes;
1922 return mpParameters->Simulation()->OutputVisualizer()->cmgui() == cp::yesno_type::yes;
1934 return mpParameters->Simulation()->OutputVisualizer()->parallel_vtk() == cp::yesno_type::yes;
1946 return mpParameters->Simulation()->OutputVisualizer()->vtk() == cp::yesno_type::yes;
1958 return mpParameters->Simulation()->OutputVisualizer()->precision();
1964 return mpParameters->Simulation()->Electrodes().present();
1972 mpParameters->Simulation()->SpaceDimension().set(spaceDimension);
1977 XSD_CREATE_WITH_FIXED_ATTR1(cp::time_type, time, simulationDuration,
"ms");
1978 mpParameters->Simulation()->SimulationDuration().set(time);
1988 cp::ionic_model_selection_type ionic_model;
1989 ionic_model.Hardcoded(rIonicModel);
1990 cp::ionic_models_type container(ionic_model);
1991 mpParameters->Simulation()->IonicModels().set(container);
1998 XSD_CREATE_WITH_FIXED_ATTR(cp::mesh_type, mesh_to_load,
"cm");
2002 cp::slab_type slab_definition(x, y, z, inter_node_space);
2003 mpParameters->Simulation()->Mesh()->Slab().set(slab_definition);
2010 XSD_CREATE_WITH_FIXED_ATTR(cp::mesh_type, mesh_to_load,
"cm");
2014 cp::sheet_type sheet_definition(x, y, inter_node_space);
2015 mpParameters->Simulation()->Mesh()->Sheet().set(sheet_definition);
2022 XSD_CREATE_WITH_FIXED_ATTR(cp::mesh_type, mesh_to_load,
"cm");
2026 cp::fibre_type fibre_definition(x, inter_node_space);
2027 mpParameters->Simulation()->Mesh()->Fibre().set(fibre_definition);
2034 XSD_CREATE_WITH_FIXED_ATTR(cp::mesh_type, mesh_to_load,
"cm");
2038 XSD_NESTED_TYPE(cp::mesh_type::LoadMesh)
2039 mesh_prefix(meshPrefix, fibreDefinition);
2040 mpParameters->Simulation()->Mesh()->LoadMesh().set(mesh_prefix);
2044 std::vector<cp::ionic_model_selection_type>& rIonicModels)
const
2046 assert(rDefinedRegions.size() == rIonicModels.size());
2048 assert(
mpParameters->Simulation()->IonicModels().present());
2049 XSD_SEQUENCE_TYPE(cp::ionic_models_type::Region)& regions =
mpParameters->Simulation()->IonicModels()->Region();
2051 for (
unsigned region_index = 0; region_index < rDefinedRegions.size(); region_index++)
2053 cp::point_type point_a(rDefinedRegions[region_index].rGetLowerCorner()[0],
2054 rDefinedRegions[region_index].rGetLowerCorner()[1],
2055 rDefinedRegions[region_index].rGetLowerCorner()[2]);
2057 cp::point_type point_b(rDefinedRegions[region_index].rGetUpperCorner()[0],
2058 rDefinedRegions[region_index].rGetUpperCorner()[1],
2059 rDefinedRegions[region_index].rGetUpperCorner()[2]);
2061 XSD_CREATE_WITH_FIXED_ATTR(cp::location_type, locn,
"cm");
2062 locn.Cuboid().set(cp::box_type(point_a, point_b));
2064 cp::ionic_model_region_type region(rIonicModels[region_index], locn);
2065 regions.push_back(region);
2070 std::vector<c_vector<double, 3> >& rIntraConductivities,
2071 std::vector<c_vector<double, 3> >& rExtraConductivities)
2073 assert(rConductivityAreas.size() == rIntraConductivities.size());
2074 assert(rIntraConductivities.size() == rExtraConductivities.size());
2076 XSD_ANON_SEQUENCE_TYPE(cp::physiological_type, ConductivityHeterogeneities, ConductivityHeterogeneity)
2077 heterogeneities_container;
2079 for (
unsigned region_index = 0; region_index < rConductivityAreas.size(); region_index++)
2081 cp::point_type point_a(rConductivityAreas[region_index].rGetLowerCorner()[0],
2082 rConductivityAreas[region_index].rGetLowerCorner()[1],
2083 rConductivityAreas[region_index].rGetLowerCorner()[2]);
2085 cp::point_type point_b(rConductivityAreas[region_index].rGetUpperCorner()[0],
2086 rConductivityAreas[region_index].rGetUpperCorner()[1],
2087 rConductivityAreas[region_index].rGetUpperCorner()[2]);
2089 XSD_CREATE_WITH_FIXED_ATTR(cp::location_type, locn,
"cm");
2090 locn.Cuboid().set(cp::box_type(point_a, point_b));
2091 cp::conductivity_heterogeneity_type ht(locn);
2093 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, intra,
2094 rIntraConductivities[region_index][0],
2095 rIntraConductivities[region_index][1],
2096 rIntraConductivities[region_index][2],
2099 ht.IntracellularConductivities(intra);
2101 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, extra,
2102 rExtraConductivities[region_index][0],
2103 rExtraConductivities[region_index][1],
2104 rExtraConductivities[region_index][2],
2107 ht.ExtracellularConductivities(extra);
2109 heterogeneities_container.push_back(ht);
2112 XSD_ANON_TYPE(cp::physiological_type, ConductivityHeterogeneities)
2113 heterogeneities_object;
2114 heterogeneities_object.ConductivityHeterogeneity(heterogeneities_container);
2116 mpParameters->Physiological().ConductivityHeterogeneities().set(heterogeneities_object);
2120 std::vector<c_vector<double, 3> >& rIntraConductivities,
2121 std::vector<c_vector<double, 3> >& rExtraConductivities)
2123 assert(rConductivityAreas.size() == rIntraConductivities.size());
2124 assert(rIntraConductivities.size() == rExtraConductivities.size());
2126 XSD_ANON_SEQUENCE_TYPE(cp::physiological_type, ConductivityHeterogeneities, ConductivityHeterogeneity)
2127 heterogeneities_container;
2129 for (
unsigned region_index = 0; region_index < rConductivityAreas.size(); region_index++)
2131 cp::point_type centre(rConductivityAreas[region_index].rGetCentre()[0],
2132 rConductivityAreas[region_index].rGetCentre()[1],
2133 rConductivityAreas[region_index].rGetCentre()[2]);
2135 cp::point_type radii(rConductivityAreas[region_index].rGetRadii()[0],
2136 rConductivityAreas[region_index].rGetRadii()[1],
2137 rConductivityAreas[region_index].rGetRadii()[2]);
2139 XSD_CREATE_WITH_FIXED_ATTR(cp::location_type, locn,
"cm");
2140 locn.Ellipsoid().set(cp::ellipsoid_type(centre, radii));
2141 cp::conductivity_heterogeneity_type ht(locn);
2143 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, intra,
2144 rIntraConductivities[region_index][0],
2145 rIntraConductivities[region_index][1],
2146 rIntraConductivities[region_index][2],
2149 ht.IntracellularConductivities(intra);
2151 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, extra,
2152 rExtraConductivities[region_index][0],
2153 rExtraConductivities[region_index][1],
2154 rExtraConductivities[region_index][2],
2157 ht.ExtracellularConductivities(extra);
2159 heterogeneities_container.push_back(ht);
2162 XSD_ANON_TYPE(cp::physiological_type, ConductivityHeterogeneities)
2163 heterogeneities_object;
2164 heterogeneities_object.ConductivityHeterogeneity(heterogeneities_container);
2166 mpParameters->Physiological().ConductivityHeterogeneities().set(heterogeneities_object);
2171 mpParameters->Simulation()->OutputDirectory().set(rOutputDirectory);
2176 mpParameters->Simulation()->OutputFilenamePrefix().set(rOutputFilenamePrefix);
2181 if (!
mpParameters->Simulation()->OutputVariables().present())
2183 cp::output_variables_type variables_requested;
2184 mpParameters->Simulation()->OutputVariables().set(variables_requested);
2187 XSD_SEQUENCE_TYPE(cp::output_variables_type::Var)& var_type_sequence =
mpParameters->Simulation()->OutputVariables()->Var();
2189 var_type_sequence.clear();
2191 for (
unsigned i = 0; i < rOutputVariables.size(); i++)
2193 cp::var_type temp(rOutputVariables[i]);
2194 var_type_sequence.push_back(temp);
2201 mpParameters->Simulation()->OutputUsingOriginalNodeOrdering().set(useOriginal ? cp::yesno_type::yes : cp::yesno_type::no);
2209 assert(checkpointTimestep != -1.0 && maxCheckpointsOnDisk != UINT_MAX);
2211 XSD_CREATE_WITH_FIXED_ATTR2(cp::simulation_type::XSD_NESTED_TYPE(CheckpointSimulation),
2214 maxCheckpointsOnDisk,
2216 mpParameters->Simulation()->CheckpointSimulation().set(cs);
2220 mpParameters->Simulation()->CheckpointSimulation().reset();
2230 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, intra,
2231 rIntraConductivities[0],
2232 rIntraConductivities[1],
2233 rIntraConductivities[2],
2236 mpParameters->Physiological().IntracellularConductivities().set(intra);
2241 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, intra,
2242 rIntraConductivities[0],
2243 rIntraConductivities[1],
2246 mpParameters->Physiological().IntracellularConductivities().set(intra);
2251 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, intra,
2252 rIntraConductivities[0],
2255 mpParameters->Physiological().IntracellularConductivities().set(intra);
2260 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, extra,
2261 rExtraConductivities[0],
2262 rExtraConductivities[1],
2263 rExtraConductivities[2],
2266 mpParameters->Physiological().ExtracellularConductivities().set(extra);
2271 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, extra,
2272 rExtraConductivities[0],
2273 rExtraConductivities[1],
2276 mpParameters->Physiological().ExtracellularConductivities().set(extra);
2281 XSD_CREATE_WITH_FIXED_ATTR3(cp::conductivities_type, extra,
2282 rExtraConductivities[0],
2285 mpParameters->Physiological().ExtracellularConductivities().set(extra);
2290 XSD_CREATE_WITH_FIXED_ATTR1(cp::conductivity_type, cond, bathConductivity,
"mS/cm");
2291 mpParameters->Physiological().BathConductivity().set(cond);
2308 if (tissueIds.empty() || bathIds.empty())
2310 EXCEPTION(
"Identifying set must be non-empty");
2312 std::set<unsigned> shared_identifiers;
2313 std::set_intersection(tissueIds.begin(),
2317 std::inserter(shared_identifiers, shared_identifiers.begin()));
2319 if (!shared_identifiers.empty())
2321 EXCEPTION(
"Tissue identifiers and bath identifiers overlap");
2329 XSD_CREATE_WITH_FIXED_ATTR1(cp::inverse_length_type, ratio_object, ratio,
"1/cm");
2330 mpParameters->Physiological().SurfaceAreaToVolumeRatio().set(ratio_object);
2335 XSD_CREATE_WITH_FIXED_ATTR1(cp::capacitance_type, capacitance_object, capacitance,
"uF/cm^2");
2336 mpParameters->Physiological().Capacitance().set(capacitance_object);
2342 XSD_CREATE_WITH_FIXED_ATTR3(cp::time_steps_type, time_steps,
2343 odeTimeStep, pdeTimeStep, printingTimeStep,
"ms");
2367 EXCEPTION(
"Ode time-step should be positive");
2371 EXCEPTION(
"Pde time-step should be positive");
2375 EXCEPTION(
"Printing time-step should be positive");
2380 EXCEPTION(
"Printing time-step should not be smaller than PDE time-step");
2385 EXCEPTION(
"Printing time-step should be a multiple of PDE time step");
2390 EXCEPTION(
"Ode time-step should not be greater than PDE time-step");
2397 EXCEPTION(
"Checkpoint time-step should be positive");
2402 EXCEPTION(
"Checkpoint time-step should be a multiple of printing time-step");
2409 ENSURE_SECTION_PRESENT(
mpParameters->Numerical().KSPTolerances(), cp::ksp_tolerances_type);
2411 mpParameters->Numerical().KSPTolerances()->KSPAbsolute().reset();
2412 mpParameters->Numerical().KSPTolerances()->KSPRelative().set(relativeTolerance);
2417 ENSURE_SECTION_PRESENT(
mpParameters->Numerical().KSPTolerances(), cp::ksp_tolerances_type);
2419 mpParameters->Numerical().KSPTolerances()->KSPRelative().reset();
2420 mpParameters->Numerical().KSPTolerances()->KSPAbsolute().set(absoluteTolerance);
2425 if (warnOfChange && strcmp(
GetKSPSolver(), kspSolver) != 0)
2428 WARNING(
"Code has changed the KSP solver type from " <<
GetKSPSolver() <<
" to " << kspSolver);
2432 if (strcmp(kspSolver,
"gmres") == 0)
2434 mpParameters->Numerical().KSPSolver().set(cp::ksp_solver_type::gmres);
2437 if (strcmp(kspSolver,
"cg") == 0)
2439 mpParameters->Numerical().KSPSolver().set(cp::ksp_solver_type::cg);
2442 if (strcmp(kspSolver,
"symmlq") == 0)
2444 mpParameters->Numerical().KSPSolver().set(cp::ksp_solver_type::symmlq);
2447 if (strcmp(kspSolver,
"chebychev") == 0)
2449 mpParameters->Numerical().KSPSolver().set(cp::ksp_solver_type::chebychev);
2453 EXCEPTION(
"Unknown solver type provided");
2459 if (strcmp(kspPreconditioner,
"jacobi") == 0)
2461 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::jacobi);
2464 if (strcmp(kspPreconditioner,
"bjacobi") == 0)
2466 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::bjacobi);
2469 if (strcmp(kspPreconditioner,
"hypre") == 0)
2471 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::hypre);
2474 if (strcmp(kspPreconditioner,
"ml") == 0)
2476 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::ml);
2479 if (strcmp(kspPreconditioner,
"spai") == 0)
2481 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::spai);
2484 if (strcmp(kspPreconditioner,
"twolevelsblockdiagonal") == 0)
2486 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::twolevelsblockdiagonal);
2489 if (strcmp(kspPreconditioner,
"blockdiagonal") == 0)
2491 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::blockdiagonal);
2494 if (strcmp(kspPreconditioner,
"ldufactorisation") == 0)
2496 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::ldufactorisation);
2499 if (strcmp(kspPreconditioner,
"none") == 0)
2501 mpParameters->Numerical().KSPPreconditioner().set(cp::ksp_preconditioner_type::none);
2505 EXCEPTION(
"Unknown preconditioner type provided");
2511 if (strcmp(meshPartioningMethod,
"dumb") == 0)
2513 mpParameters->Numerical().MeshPartitioning().set(cp::mesh_partitioning_type::dumb);
2516 if (strcmp(meshPartioningMethod,
"metis") == 0)
2518 WARNING(
"METIS library partitioning is deprecated")
2519 mpParameters->Numerical().MeshPartitioning().set(cp::mesh_partitioning_type::metis);
2522 if (strcmp(meshPartioningMethod,
"parmetis") == 0)
2524 mpParameters->Numerical().MeshPartitioning().set(cp::mesh_partitioning_type::parmetis);
2527 if (strcmp(meshPartioningMethod,
"petsc") == 0)
2529 mpParameters->Numerical().MeshPartitioning().set(cp::mesh_partitioning_type::petsc);
2533 EXCEPTION(
"Unknown mesh partitioning method provided");
2539 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ActionPotentialDurationMap)& apd_maps_sequence
2540 =
mpParameters->PostProcessing()->ActionPotentialDurationMap();
2542 apd_maps_sequence.clear();
2544 for (
unsigned i = 0; i < apdMaps.size(); i++)
2546 XSD_CREATE_WITH_FIXED_ATTR2(cp::apd_map_type, temp,
2547 apdMaps[i].first, apdMaps[i].second,
2549 apd_maps_sequence.push_back(temp);
2556 XSD_SEQUENCE_TYPE(cp::postprocessing_type::UpstrokeTimeMap)& var_type_sequence
2560 var_type_sequence.clear();
2562 for (
unsigned i = 0; i < upstrokeTimeMaps.size(); i++)
2564 XSD_CREATE_WITH_FIXED_ATTR1(cp::upstrokes_map_type, temp,
2565 upstrokeTimeMaps[i],
2567 var_type_sequence.push_back(temp);
2574 XSD_SEQUENCE_TYPE(cp::postprocessing_type::MaxUpstrokeVelocityMap)& max_upstroke_velocity_maps_sequence
2575 =
mpParameters->PostProcessing()->MaxUpstrokeVelocityMap();
2578 max_upstroke_velocity_maps_sequence.clear();
2580 for (
unsigned i = 0; i < maxUpstrokeVelocityMaps.size(); i++)
2582 XSD_CREATE_WITH_FIXED_ATTR1(cp::max_upstrokes_velocity_map_type, temp,
2583 maxUpstrokeVelocityMaps[i],
2586 max_upstroke_velocity_maps_sequence.push_back(temp);
2593 XSD_SEQUENCE_TYPE(cp::postprocessing_type::ConductionVelocityMap)& conduction_velocity_maps_sequence
2594 =
mpParameters->PostProcessing()->ConductionVelocityMap();
2597 conduction_velocity_maps_sequence.clear();
2599 for (
unsigned i = 0; i < conductionVelocityMaps.size(); i++)
2601 cp::conduction_velocity_map_type temp(conductionVelocityMaps[i]);
2602 conduction_velocity_maps_sequence.push_back(temp);
2609 XSD_SEQUENCE_TYPE(cp::postprocessing_type::TimeTraceAtNode)& requested_nodes_sequence
2613 requested_nodes_sequence.clear();
2615 for (
unsigned i = 0; i < requestedNodes.size(); i++)
2617 cp::node_number_type temp(requestedNodes[i]);
2618 requested_nodes_sequence.push_back(temp);
2622template <
unsigned SPACE_DIM>
2626 XSD_SEQUENCE_TYPE(cp::postprocessing_type::PseudoEcgElectrodePosition)& electrodes_sequence
2627 =
mpParameters->PostProcessing()->PseudoEcgElectrodePosition();
2630 electrodes_sequence.clear();
2632 for (
unsigned i = 0; i < rPseudoEcgElectrodePositions.size(); i++)
2634 cp::point_type temp(rPseudoEcgElectrodePositions[i].GetWithDefault(0),
2635 rPseudoEcgElectrodePositions[i].GetWithDefault(1),
2636 rPseudoEcgElectrodePositions[i].GetWithDefault(2));
2637 electrodes_sequence.push_back(temp);
2647 ENSURE_SECTION_PRESENT(
mpParameters->Simulation()->OutputVisualizer(), cp::output_visualizer_type);
2654 mpParameters->Simulation()->OutputVisualizer()->meshalyzer(
2655 useMeshalyzer ? cp::yesno_type::yes : cp::yesno_type::no);
2663 useCmgui ? cp::yesno_type::yes : cp::yesno_type::no);
2671 useVtk ? cp::yesno_type::yes : cp::yesno_type::no);
2678 mpParameters->Simulation()->OutputVisualizer()->parallel_vtk(
2679 useParallelVtk ? cp::yesno_type::yes : cp::yesno_type::no);
2686 mpParameters->Simulation()->OutputVisualizer()->precision(numberOfDigits);
2690 unsigned index,
double magnitude,
2691 double startTime,
double duration)
2695 cp::axis_type axis = cp::axis_type::x;
2698 axis = cp::axis_type::y;
2700 else if (index == 2)
2702 axis = cp::axis_type::z;
2705 XSD_CREATE_WITH_FIXED_ATTR1(cp::surface_stimulus_strength_type, strength, magnitude,
"uA/cm^2");
2706 XSD_CREATE_WITH_FIXED_ATTR1(cp::time_type, start_time, startTime,
"ms");
2707 XSD_CREATE_WITH_FIXED_ATTR1(cp::time_type, duration_time, duration,
"ms");
2711 cp::electrodes_type element(groundSecondElectrode ? cp::yesno_type::yes : cp::yesno_type::no,
2720 mpParameters->Simulation()->Electrodes()->GroundSecondElectrode(groundSecondElectrode ? cp::yesno_type::yes : cp::yesno_type::no);
2721 mpParameters->Simulation()->Electrodes()->PerpendicularToAxis(axis);
2722 mpParameters->Simulation()->Electrodes()->Strength(strength);
2723 mpParameters->Simulation()->Electrodes()->StartTime(start_time);
2724 mpParameters->Simulation()->Electrodes()->Duration(duration_time);
2729 unsigned& rIndex,
double& rMagnitude,
2730 double& rStartTime,
double& rDuration)
2734 EXCEPTION(
"Attempted to get electrodes that have not been defined.");
2738 rGroundSecondElectrode = (
mpParameters->Simulation()->Electrodes()->GroundSecondElectrode() == cp::yesno_type::yes);
2740 cp::axis_type axis =
mpParameters->Simulation()->Electrodes()->PerpendicularToAxis();
2741 if (axis == cp::axis_type::x)
2745 else if (axis == cp::axis_type::y)
2754 rMagnitude =
mpParameters->Simulation()->Electrodes()->Strength();
2755 rStartTime =
mpParameters->Simulation()->Electrodes()->StartTime();
2756 rDuration =
mpParameters->Simulation()->Electrodes()->Duration();
2763 bool result =
false;
2764 if (
mpParameters->Numerical().UseStateVariableInterpolation().present())
2766 result =
mpParameters->Numerical().UseStateVariableInterpolation().get() == cp::yesno_type::yes;
2773 if (useStateVariableInterpolation)
2775 mpParameters->Numerical().UseStateVariableInterpolation().set(cp::yesno_type::yes);
2779 mpParameters->Numerical().UseStateVariableInterpolation().set(cp::yesno_type::no);
2785 return mpParameters->Physiological().ApplyDrug().present();
2790 CHECK_EXISTS(
HasDrugDose(),
"Physiological/ApplyDrug");
2791 return mpParameters->Physiological().ApplyDrug()->concentration();
2796 if (!
mpParameters->Physiological().ApplyDrug().present())
2798 cp::apply_drug_type drug(drugDose);
2803 mpParameters->Physiological().ApplyDrug()->concentration(drugDose);
2809 CHECK_EXISTS(
HasDrugDose(),
"Physiological/ApplyDrug");
2810 std::map<std::string, std::pair<double, double> > ic50s;
2812 XSD_SEQUENCE_TYPE(cp::apply_drug_type::IC50)& ic50_seq =
mpParameters->Physiological().ApplyDrug()->IC50();
2814 for (XSD_ITERATOR_TYPE(cp::apply_drug_type::IC50) i = ic50_seq.begin();
2815 i != ic50_seq.end();
2818 std::pair<double, double> ic50_hill(*i, i->hill());
2819 std::string current = i->current();
2820 ic50s[current] = ic50_hill;
2828 if (!
mpParameters->Physiological().ApplyDrug().present())
2832 XSD_SEQUENCE_TYPE(cp::apply_drug_type::IC50)& ic50_seq =
mpParameters->Physiological().ApplyDrug()->IC50();
2833 if (ic50_seq.empty())
2838 bool entry_exists =
false;
2839 cp::ic50_type ic50_elt(ic50, rCurrentName);
2840 ic50_elt.hill(hill);
2841 for (XSD_ITERATOR_TYPE(cp::apply_drug_type::IC50) i = ic50_seq.begin();
2842 i != ic50_seq.end();
2845 if (i->current() == rCurrentName)
2847 entry_exists =
true;
2854 ic50_seq.push_back(ic50_elt);
2911 return mpParameters->Simulation()->Purkinje().present();
2916 CHECK_EXISTS(
mpParameters->Physiological().Purkinje().present(),
"Physiological/Purkinje");
2917 CHECK_EXISTS(
mpParameters->Physiological().Purkinje()->Capacitance().present(),
2918 "Physiological/Purkinje/Capacitance");
2919 return mpParameters->Physiological().Purkinje()->Capacitance().get();
2924 ENSURE_SECTION_PRESENT(
mpParameters->Physiological().Purkinje(), cp::purkinje_physiological_type);
2925 XSD_CREATE_WITH_FIXED_ATTR1(cp::capacitance_type, purk_Cm, capacitance,
"uF/cm^2");
2926 mpParameters->Physiological().Purkinje()->Capacitance().set(purk_Cm);
2931 CHECK_EXISTS(
mpParameters->Physiological().Purkinje().present(),
"Physiological/Purkinje");
2932 CHECK_EXISTS(
mpParameters->Physiological().Purkinje()->SurfaceAreaToVolumeRatio().present(),
2933 "Physiological/Purkinje/SurfaceAreaToVolumeRatio");
2934 return mpParameters->Physiological().Purkinje()->SurfaceAreaToVolumeRatio().get();
2939 ENSURE_SECTION_PRESENT(
mpParameters->Physiological().Purkinje(), cp::purkinje_physiological_type);
2940 XSD_CREATE_WITH_FIXED_ATTR1(cp::inverse_length_type, purk_Am, ratio,
"1/cm");
2941 mpParameters->Physiological().Purkinje()->SurfaceAreaToVolumeRatio().set(purk_Am);
2946 CHECK_EXISTS(
mpParameters->Physiological().Purkinje().present(),
"Physiological/Purkinje");
2947 CHECK_EXISTS(
mpParameters->Physiological().Purkinje()->Conductivity().present(),
2948 "Physiological/Purkinje/Conductivity");
2949 return mpParameters->Physiological().Purkinje()->Conductivity().get();
2954 ENSURE_SECTION_PRESENT(
mpParameters->Physiological().Purkinje(), cp::purkinje_physiological_type);
2955 XSD_CREATE_WITH_FIXED_ATTR1(cp::conductivity_type, purkinje_conductivity, conductivity,
"mS/cm");
2956 mpParameters->Physiological().Purkinje()->Conductivity().set(purkinje_conductivity);
2968 xercesc::DOMElement* pRootElement)
2970 using namespace xercesc;
2973 "ResumeSimulation/ArchiveDirectory");
2974 if (elts.size() > 0)
2977 DOMElement* p_dir_elt = elts[0];
2978 p_dir_elt->setAttribute(X(
"relative_to"), X(
"chaste_test_output"));
2983 xercesc::DOMElement* pRootElement)
2988 "Simulation/IonicModels/Default");
2989 if (p_elt_list.size() > 0)
2991 assert(p_elt_list.size() == 1);
2995 for (
unsigned i = 0; i < p_elt_list.size(); i++)
3003 xercesc::DOMElement* pRootElement)
3007 "Numerical/KSPPreconditioner");
3008 if (p_elt_list.size() > 0)
3010 assert(p_elt_list.size() == 1);
3011 std::string text_value = X2C(p_elt_list[0]->getTextContent());
3012 if (text_value ==
"ilu")
3014 EXCEPTION(
"PETSc does not have a parallel implementation of ilu, so we no longer allow it as an option. Use bjacobi instead.");
3020 xercesc::DOMElement* pRootElement)
3024 "Simulation/ConductivityHeterogeneities");
3025 if (p_elt_list.size() > 0)
3027 assert(p_elt_list.size() == 1);
3028 xercesc::DOMNode* p_parent = p_elt_list[0]->getParentNode();
3029 xercesc::DOMNode* p_child = p_parent->removeChild(p_elt_list[0]);
3031 assert(p_phys_list.size() == 1);
3032 p_phys_list[0]->appendChild(p_child);
3037 xercesc::DOMElement* pRootElement)
3040 if (p_sim_list.size() > 0)
3042 std::vector<xercesc::DOMElement*> p_viz_list =
XmlTools::FindElements(p_sim_list[0],
"OutputVisualizer");
3043 if (p_viz_list.empty())
3046 xercesc::DOMElement* p_viz_elt = pDocument->createElementNS(X(
"https://chaste.comlab.ox.ac.uk/nss/parameters/3_3"), X(
"OutputVisualizer"));
3047 p_sim_list[0]->appendChild(p_viz_elt);
3048 p_viz_elt->setAttribute(X(
"meshalyzer"), X(
"yes"));
3061template void HeartConfig::GetIonicModelRegions<3u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<3u> > >&, std::vector<cp::ionic_model_selection_type>&)
const;
3062template void HeartConfig::GetStimuli<3u>(std::vector<boost::shared_ptr<AbstractStimulusFunction> >&, std::vector<boost::shared_ptr<
AbstractChasteRegion<3u> > >&)
const;
3063template void HeartConfig::GetCellHeterogeneities<3u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<3u> > >&, std::vector<double>&, std::vector<double>&, std::vector<double>&, std::vector<std::map<std::string, double> >*);
3064template void HeartConfig::GetConductivityHeterogeneities<3u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<3u> > >&, std::vector<c_vector<double, 3> >&, std::vector<c_vector<double, 3> >&)
const;
3066template void HeartConfig::GetIonicModelRegions<2u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<2u> > >&, std::vector<cp::ionic_model_selection_type>&)
const;
3067template void HeartConfig::GetStimuli<2u>(std::vector<boost::shared_ptr<AbstractStimulusFunction> >&, std::vector<boost::shared_ptr<
AbstractChasteRegion<2u> > >&)
const;
3068template void HeartConfig::GetCellHeterogeneities<2u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<2u> > >&, std::vector<double>&, std::vector<double>&, std::vector<double>&, std::vector<std::map<std::string, double> >*);
3069template void HeartConfig::GetConductivityHeterogeneities<2u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<2u> > >&, std::vector<c_vector<double, 3> >&, std::vector<c_vector<double, 3> >&)
const;
3071template void HeartConfig::GetIonicModelRegions<1u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<1u> > >&, std::vector<cp::ionic_model_selection_type>&)
const;
3072template void HeartConfig::GetStimuli<1u>(std::vector<boost::shared_ptr<AbstractStimulusFunction> >&, std::vector<boost::shared_ptr<
AbstractChasteRegion<1u> > >&)
const;
3073template void HeartConfig::GetCellHeterogeneities<1u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<1u> > >&, std::vector<double>&, std::vector<double>&, std::vector<double>&, std::vector<std::map<std::string, double> >*);
3074template void HeartConfig::GetConductivityHeterogeneities<1u>(std::vector<boost::shared_ptr<
AbstractChasteRegion<1u> > >&, std::vector<c_vector<double, 3> >&, std::vector<c_vector<double, 3> >&)
const;
#define EXCEPTION(message)
void MergeDefaults(boost::shared_ptr< cp::chaste_parameters_type > pParams, boost::shared_ptr< cp::chaste_parameters_type > pDefaults)
boost::shared_ptr< cp::chaste_parameters_type > CreateDefaultParameters()
#define CHASTE_CLASS_EXPORT(T)
static std::string GetArchiveDirectory()
static const char * GetRootDir()
virtual void SetPath(const std::string &rPath, RelativeTo::Value relativeTo)
FileFinder CopyTo(const FileFinder &rDest) const
static void SetFilePermissions(const fs::path &rPath)
SchemaLocationsMap mSchemaLocations
void SetRequestedNodalTimeTraces(std::vector< unsigned > &requestedNodes)
void GetStimuli(std::vector< boost::shared_ptr< AbstractStimulusFunction > > &rStimuliApplied, std::vector< boost::shared_ptr< AbstractChasteRegion< DIM > > > &rStimulatedAreas) const
DistributedTetrahedralMeshPartitionType::type GetMeshPartitioning() const
bool AreCellularTransmuralHeterogeneitiesRequested()
unsigned GetMaxCheckpointsOnDisk() const
std::map< std::string, std::string > SchemaLocationsMap
bool IsSimulationDefined() const
void SetUseMassLumpingForPrecond(bool useMassLumping=true)
void SetIntracellularConductivities(const c_vector< double, 3 > &rIntraConductivities)
void GetSheetDimensions(c_vector< double, 2 > &sheetDimensions) const
void SetTissueAndBathIdentifiers(const std::set< unsigned > &rTissueIds, const std::set< unsigned > &rBathIds)
std::string GetMeshName() const
cp::media_type GetConductivityMedia() const
double GetCapacitance() const
std::set< unsigned > mBathIdentifiers
void SetMaxUpstrokeVelocityMaps(std::vector< double > &rMaxUpstrokeVelocityMaps)
void SetConductivityHeterogeneitiesEllipsoid(std::vector< ChasteEllipsoid< 3 > > &rConductivityAreas, std::vector< c_vector< double, 3 > > &rIntraConductivities, std::vector< c_vector< double, 3 > > &rExtraConductivities)
double GetAbsoluteTolerance() const
void SetUseFixedNumberIterationsLinearSolver(bool useFixedNumberIterations=true, unsigned evaluateNumItsEveryNSolves=UINT_MAX)
void SetBathMultipleConductivities(std::map< unsigned, double > bathConductivities)
double GetPurkinjeSurfaceAreaToVolumeRatio()
HeartFileFinder GetArchivedSimulationDir() const
static boost::shared_ptr< HeartConfig > mpInstance
double GetPdeTimeStep() const
bool mUseFixedNumberIterations
double GetDrugDose() const
bool GetCreateFibre() const
double GetPrintingTimeStep() const
void SetDefaultIonicModel(const cp::ionic_models_available_type &rIonicModel)
void CheckResumeSimulationIsDefined(std::string callingMethod="") const
bool GetUseFixedNumberIterationsLinearSolver()
void CopySchema(const std::string &rToDirectory)
void SetElectrodeParameters(bool groundSecondElectrode, unsigned index, double magnitude, double startTime, double duration)
void GetOutputVariables(std::vector< std::string > &rOutputVariables) const
void SetSheetDimensions(double x, double y, double inter_node_space)
bool mUseFixedSchemaLocation
void SetPrintingTimeStep(double printingTimeStep)
boost::shared_ptr< cp::chaste_parameters_type > mpParameters
double GetMidLayerFraction()
void SetFibreLength(double x, double inter_node_space)
unsigned GetVisualizerOutputPrecision()
void SetPurkinjeCapacitance(double capacitance)
bool IsOutputVisualizerPresent() const
void SetUpstrokeTimeMaps(std::vector< double > &rUpstrokeTimeMaps)
void SetApdMaps(const std::vector< std::pair< double, double > > &rApdMaps)
double GetSurfaceAreaToVolumeRatio() const
double GetSimulationDuration() const
void SetDrugDose(double drugDose)
double GetOdeTimeStep() const
FileFinder mParametersFilePath
bool IsPostProcessingSectionPresent() const
bool IsMaxUpstrokeVelocityMapRequested() const
void SetKSPSolver(const char *kspSolver, bool warnOfChange=false)
bool IsPostProcessingRequested() const
void SetUseFixedSchemaLocation(bool useFixedSchemaLocation)
void SetOutputUsingOriginalNodeOrdering(bool useOriginal)
bool GetVisualizeWithParallelVtk() const
unsigned GetSpaceDimension() const
bool GetCreateMesh() const
void SetIc50Value(const std::string &rCurrentName, double ic50, double hill=1.0)
bool IsAnyNodalTimeTraceRequested() const
void SetOutputDirectory(const std::string &rOutputDirectory)
std::map< unsigned, double > mBathConductivities
FileFinder GetParametersFilePath()
void EnsurePostProcessingSectionPresent()
void SetUseReactionDiffusionOperatorSplitting(bool useOperatorSplitting=true)
void CheckTimeSteps() const
void GetConductivityHeterogeneities(std::vector< boost::shared_ptr< AbstractChasteRegion< DIM > > > &conductivitiesHeterogeneityAreas, std::vector< c_vector< double, 3 > > &intraConductivities, std::vector< c_vector< double, 3 > > &extraConductivities) const
void SetDomain(const cp::domain_type &rDomain)
const char * GetKSPPreconditioner() const
bool GetUseAbsoluteTolerance() const
bool IsSimulationResumed() const
void SetFixedSchemaLocations(const SchemaLocationsMap &rSchemaLocations)
bool mUserAskedForCellularTransmuralHeterogeneities
bool GetVisualizeWithCmgui() const
void EnsureOutputVisualizerExists(void)
void SetUseStateVariableInterpolation(bool useStateVariableInterpolation=true)
bool GetOutputUsingOriginalNodeOrdering()
bool IsElectrodesPresent() const
void SetMeshPartitioning(const char *meshPartioningMethod)
bool IsApdMapsRequested() const
bool IsConductionVelocityMapsRequested() const
double GetRelativeTolerance() const
void GetNodalTimeTraceRequested(std::vector< unsigned > &rRequestedNodes) const
unsigned GetMidLayerIndex()
void SetUseRelativeTolerance(double relativeTolerance)
const std::set< unsigned > & rGetBathIdentifiers()
void SetVisualizeWithMeshalyzer(bool useMeshalyzer=true)
void SetPdeTimeStep(double pdeTimeStep)
cp::ionic_model_selection_type GetDefaultIonicModel() const
void SetSlabDimensions(double x, double y, double z, double inter_node_space)
void SetSpaceDimension(unsigned spaceDimension)
unsigned GetEvaluateNumItsEveryNSolves()
boost::shared_ptr< cp::chaste_parameters_type > ReadFile(const std::string &rFileName)
unsigned mEvaluateNumItsEveryNSolves
void GetApdMaps(std::vector< std::pair< double, double > > &rApdMaps) const
void SetSurfaceAreaToVolumeRatio(double ratio)
void GetIonicModelRegions(std::vector< boost::shared_ptr< AbstractChasteRegion< DIM > > > &rDefinedRegions, std::vector< cp::ionic_model_selection_type > &rIonicModels) const
void SetUseAbsoluteTolerance(double absoluteTolerance)
bool GetUseRelativeTolerance() const
void SetPurkinjeSurfaceAreaToVolumeRatio(double ratio)
void SetKSPPreconditioner(const char *kspPreconditioner)
void GetConductionVelocityMaps(std::vector< unsigned > &rConductionVelocityMaps) const
void SetDefaultSchemaLocations()
void SetOdeTimeStep(double odeTimeStep)
bool GetCreateSlab() const
double GetPurkinjeCapacitance()
unsigned GetEpiLayerIndex()
void SetBathConductivity(double bathConductivity)
double GetPurkinjeConductivity()
void SetIonicModelRegions(std::vector< ChasteCuboid< 3 > > &rDefinedRegions, std::vector< cp::ionic_model_selection_type > &rIonicModels) const
bool GetUseReactionDiffusionOperatorSplitting()
void SetVisualizeWithVtk(bool useVtk=true)
void SetExtracellularConductivities(const c_vector< double, 3 > &rExtraConductivities)
std::string GetOutputFilenamePrefix() const
bool GetVisualizeWithMeshalyzer() const
void SetSimulationDuration(double simulationDuration)
void SetCapacitance(double capacitance)
void SetConductionVelocityMaps(std::vector< unsigned > &rConductionVelocityMaps)
double GetEndoLayerFraction()
void SetConductivityHeterogeneities(std::vector< ChasteCuboid< 3 > > &rConductivityAreas, std::vector< c_vector< double, 3 > > &rIntraConductivities, std::vector< c_vector< double, 3 > > &rExtraConductivities)
bool GetConductivityHeterogeneitiesProvided() const
void SetOutputVariables(const std::vector< std::string > &rOutputVariables)
void GetSlabDimensions(c_vector< double, 3 > &slabDimensions) const
void GetPseudoEcgElectrodePositions(std::vector< ChastePoint< SPACE_DIM > > &rPseudoEcgElectrodePositions) const
void GetElectrodeParameters(bool &rGroundSecondElectrode, unsigned &rIndex, double &rMagnitude, double &rStartTime, double &rDuration)
void LoadFromCheckpoint()
void Write(bool useArchiveLocationInfo=false, std::string subfolderName="output")
std::map< std::string, std::pair< double, double > > GetIc50Values()
std::set< unsigned > mTissueIdentifiers
double GetEpiLayerFraction()
unsigned GetEndoLayerIndex()
bool mUseMassLumpingForPrecond
double GetCheckpointTimestep() const
bool IsMeshProvided() const
bool GetVisualizeWithVtk() const
void SetOutputFilenamePrefix(const std::string &rOutputFilenamePrefix)
void SetCheckpointSimulation(bool checkpointSimulation, double checkpointTimestep=-1.0, unsigned maxCheckpointsOnDisk=UINT_MAX)
void SetPurkinjeConductivity(double conductivity)
void GetIntracellularConductivities(c_vector< double, 3 > &rIntraConductivities) const
bool GetUseMassLumpingForPrecond()
void SetMeshFileName(std::string meshPrefix, cp::media_type fibreDefinition=cp::media_type::NoFibreOrientation)
void GetCellHeterogeneities(std::vector< boost::shared_ptr< AbstractChasteRegion< DIM > > > &rCellHeterogeneityRegions, std::vector< double > &rScaleFactorGks, std::vector< double > &rScaleFactorIto, std::vector< double > &rScaleFactorGkr, std::vector< std::map< std::string, double > > *pParameterSettings)
void GetUpstrokeTimeMaps(std::vector< double > &rUpstrokeTimeMaps) const
bool GetUseStateVariableInterpolation() const
const std::set< unsigned > & rGetTissueIdentifiers()
unsigned GetVersionFromNamespace(const std::string &rNamespaceUri)
bool mUseReactionDiffusionOperatorSplitting
void GetMaxUpstrokeVelocityMaps(std::vector< double > &rUpstrokeVelocityMaps) const
double GetInterNodeSpace() const
cp::domain_type GetDomain() const
bool GetOutputVariablesProvided() const
std::string GetOutputDirectory() const
double GetBathConductivity(unsigned bathRegion=UINT_MAX) const
void SetUseMassLumping(bool useMassLumping=true)
bool IsPseudoEcgCalculationRequested() const
void CheckSimulationIsDefined(std::string callingMethod="") const
bool IsUpstrokeTimeMapsRequested() const
void SetVisualizeWithCmgui(bool useCmgui=true)
void GetExtracellularConductivities(c_vector< double, 3 > &rExtraConductivities) const
bool GetCheckpointSimulation() const
void SetVisualizeWithParallelVtk(bool useParallelVtk=true)
void UpdateParametersFromResumeSimulation(boost::shared_ptr< cp::chaste_parameters_type > pResumeParameters)
void SetParametersFile(const std::string &rFileName)
void GetFibreLength(c_vector< double, 1 > &fibreLength) const
static HeartConfig * Instance()
const char * GetKSPSolver() const
void SetVisualizerOutputPrecision(unsigned numberOfDigits)
void SetOdePdeAndPrintingTimeSteps(double odeTimeStep, double pdeTimeStep, double printingTimeStep)
void SetPseudoEcgElectrodePositions(const std::vector< ChastePoint< SPACE_DIM > > &rPseudoEcgElectrodePositions)
bool IsAdaptivityParametersPresent() const
bool GetCreateSheet() const
static bool IsRegionBath(HeartRegionType regionId)
std::string GetOutputDirectoryFullPath() const