Typedefs
using	PreconditionerMapType = std::pair< PreconditionerType, bool >
	Map for preconditioner type string to pair (PreconditionerType enum, bool(true if Trilinos precondition)). More...

Enumerations
enum class	BodyForceType { bfType_vol = 0 , bfType_trac = 1 , bfType_Neu = 2 , bfType_std = 3 , bfType_ustd = 4 , bfType_spl = 5 , bfType_gen = 6 }
	Body force types: volumetric (default), traction, Neumann (pressure based), time dependence (steady, unsteady, spatially varying, general) More...

enum class	BoundaryConditionType { bType_Dir = 0 , bType_Neu = 1 , bType_trac = 2 , bType_CMM = 3 , bType_Robin = 4 , bType_std = 5 , bType_ustd = 6 , bType_cpl = 7 , bType_gen = 8 , bType_res = 9 , bType_flx = 10 , bType_zp = 11 , bType_impD = 12 , bType_flat =13 , bType_para = 14 , bType_ud = 15 , bType_bfs = 16 , bType_fix = 17 , bType_hing = 18 , bType_free = 19 , bType_symm = 20 , bType_undefNeu = 21 , bType_RCR = 22 }
	Boundary conditions type. More...

enum class	ConstitutiveModelType { stIso_NA = 600 , stIso_StVK = 601 , stIso_mStVK = 602 , stIso_nHook = 603 , stIso_MR = 604 , stIso_HGO = 605 , stIso_lin = 606 , stIso_Gucci = 607 , stIso_HO = 608 , stIso_HO_ma = 610 , stIso_LS = 611 , stVol_NA = 650 , stVol_Quad = 651 , stVol_ST91 = 652 , stVol_M94 = 653 }

enum class	ContactModelType { cntctM_NA = 800 , cntctM_penalty = 801 , cntctM_potential = 802 }

enum class	CplBCType { cplBC_NA = 400 , cplBC_Dir = 66112 , cplBC_E = 403 , cplBC_I = 401 , cplBC_Neu = 66113 , cplBC_SI = 402 }
	Differenty type of coupling for cplBC. More...

enum class	ElementType { NA = 100 , PNT = 101 , LIN1 = 102 , LIN2 = 103 , TRI3 = 104 , TRI6 = 105 , QUD4 = 106 , QUD8 = 107 , QUD9 = 108 , TET4 = 109 , TET10 = 110 , HEX8 = 111 , HEX20 = 112 , HEX27 = 113 , WDG = 114 , NRB = 115 }
	Element type replicating eType_NA, eType_PNT, etc. More...

enum class	EquationType { phys_NA = 200 , phys_fluid = 201 , phys_struct = 202 , phys_heatS = 203 , phys_lElas = 204 , phys_heatF = 205 , phys_FSI = 206 , phys_mesh = 207 , phys_shell = 208 , phys_CMM = 209 , phys_CEP = 210 , phys_ustruct = 211 , phys_stokes = 212 }
	Types of equations that are included in this solver. More...

enum class	MeshGeneratorType { RMSH_TETGEN = 1 , RMSH_MESHSIM = 2 }

enum class	OutputType { outGrp_NA = 500 , outGrp_A = 501 , outGrp_Y = 502 , outGrp_D = 503 , outGrp_I = 504 , outGrp_WSS = 505 , outGrp_trac = 506 , outGrp_vort = 507 , outGrp_vortex = 508 , outGrp_stInv = 509 , outGrp_eFlx = 510 , outGrp_hFlx = 511 , outGrp_absV = 512 , outGrp_fN = 513 , outGrp_fA = 514 , outGrp_stress = 515 , outGrp_cauchy = 516 , outGrp_mises = 517 , outGrp_J = 518 , outGrp_F = 519 , outGrp_strain = 520 , outGrp_divV = 521 , outGrp_Visc = 522 , outGrp_fS = 523 , outGrp_C = 524 , outGrp_I1 = 525 , out_velocity = 599 , out_pressure = 598 , out_temperature = 597 , out_voltage = 596 , out_acceleration = 595 , out_displacement = 594 , out_integ =593 , out_WSS = 592 , out_traction = 591 , out_vorticity = 590 , out_vortex = 589 , out_strainInv = 588 , out_energyFlux = 587 , out_heatFlux = 586 , out_absVelocity = 585 , out_fibDir = 584 , out_fibAlign = 583 , out_stress = 582 , out_cauchy = 581 , out_mises = 580 , out_jacobian = 579 , out_defGrad = 578 , out_strain = 577 , out_divergence = 576 , out_viscosity = 575 , out_fibStrn = 574 , out_CGstrain = 573 , out_CGInv1 = 572 }

enum class	PhysicalProperyType { NA = 0 , fluid_density = 1 , solid_density = 2 , solid_viscosity = 3 , elasticity_modulus = 4 , poisson_ratio = 5 , conductivity = 6 , f_x = 7 , f_y = 8 , f_z = 9 , backflow_stab = 10 , source_term = 11 , damping = 12 , shell_thickness = 13 , ctau_M = 14 , ctau_C = 15 }
	Possible physical properties. Current maxNPror is 20. More...

enum class	PreconditionerType { PREC_NONE = 700 , PREC_FSILS = 701 , PREC_TRILINOS_DIAGONAL = 702 , PREC_TRILINOS_BLOCK_JACOBI = 703 , PREC_TRILINOS_ILU = 704 , PREC_TRILINOS_ILUT = 705 , PREC_TRILINOS_IC = 706 , PREC_TRILINOS_ICT = 707 , PREC_TRILINOS_ML = 708 , PREC_RCS = 709 }

enum class	SolverType { lSolver_NA = 799 , lSolver_CG = 798 , lSolver_GMRES = 797 , lSolver_NS = 796 , lSolver_BICGS = 795 }

enum class	FluidViscosityModelType { viscType_CY = 697 , viscType_Cass = 696 , viscType_Const = 698 , viscType_NA = 699 }

Functions
template<typename T >
int	enum_int (T value)

template<typename T >
bool	present (T value)
	Check if a value is set to infinity. More...

template<typename T >
std::ostream &	operator<< (typename std::enable_if< std::is_enum< T >::value, std::ostream >::type &stream, const T &e)
	Template for printing enum class types as an int. More...

Variables
const std::map< ElementType, int >	element_type_to_elem_nonb
	Reproduces the 'SELECT CASE (lMeType)' statements in the Fortran 'PARTMSH' subroutine. More...

const std::map< std::string, ConstitutiveModelType >	constitutive_model_name_to_type
	Map for constitutive_model string to ConstitutiveModelType. More...

const std::map< std::string, ContactModelType >	contact_model_name_to_type
	Map for contact model string name to ContacteModelType. More...

const std::map< std::string, FluidViscosityModelType >	fluid_viscosity_model_name_to_type
	Map for fluid viscosity model string to FluidViscosityModelType. More...

const std::map< std::string, CplBCType >	cplbc_name_to_type
	Map for cplBC type to CplBCType. More...

const std::map< std::string, EquationType >	equation_name_to_type
	Map equation name to a type. More...

const std::map< std::string, MeshGeneratorType >	mesh_generator_name_to_type
	Map for string to MeshGeneratorType. More...

const std::map< std::string, PreconditionerMapType >	preconditioner_name_to_type
	Map for preconditioner type string to PreconditionerType enum. More...

const std::map< std::string, SolverType >	solver_name_to_type
	Map solver type string to SolverType enum. More...

const double	pi = 3.1415926535897932384626

const int	maxNSD = 3

const int	maxNProp = 20

const int	maxOutput = 5

const int	int_inf = std::numeric_limits<int>::infinity()
	Use inf numeric values to represent a value that is not set. More...

const double	double_inf = std::numeric_limits<double>::infinity()

constexpr auto	BC_CMM = BoundaryConditionType::bType_CMM

constexpr auto	iBC_CMM = static_cast<int>(BoundaryConditionType::bType_CMM)

constexpr auto	BC_cpl = BoundaryConditionType::bType_cpl

constexpr auto	iBC_cpl = static_cast<int>(BoundaryConditionType::bType_cpl)

constexpr auto	BC_Dir = BoundaryConditionType::bType_Dir

constexpr auto	iBC_Dir = static_cast<int>(BoundaryConditionType::bType_Dir)

constexpr auto	BC_fix = BoundaryConditionType::bType_fix

constexpr auto	iBC_fix = static_cast<int>(BoundaryConditionType::bType_fix)

constexpr auto	BC_flat = BoundaryConditionType::bType_flat

constexpr auto	iBC_flat = static_cast<int>(BoundaryConditionType::bType_flat)

constexpr auto	BC_free = BoundaryConditionType::bType_free

constexpr auto	iBC_free = static_cast<int>(BoundaryConditionType::bType_free)

constexpr auto	BC_gen = BoundaryConditionType::bType_gen

constexpr auto	iBC_gen = static_cast<int>(BoundaryConditionType::bType_gen)

constexpr auto	BC_hing = BoundaryConditionType::bType_hing

constexpr auto	iBC_hing = static_cast<int>(BoundaryConditionType::bType_hing)

constexpr auto	BC_impD = BoundaryConditionType::bType_impD

constexpr auto	iBC_impD = static_cast<int>(BoundaryConditionType::bType_impD)

constexpr auto	BC_Neu = BoundaryConditionType::bType_Neu

constexpr auto	iBC_Neu = static_cast<int>(BoundaryConditionType::bType_Neu)

constexpr auto	BC_para = BoundaryConditionType::bType_para

constexpr auto	iBC_para = static_cast<int>(BoundaryConditionType::bType_para)

constexpr auto	BC_RCR = BoundaryConditionType::bType_RCR

constexpr auto	iBC_RCR = static_cast<int>(BoundaryConditionType::bType_RCR)

constexpr auto	BC_res = BoundaryConditionType::bType_res

constexpr auto	iBC_res = static_cast<int>(BoundaryConditionType::bType_res)

constexpr auto	BC_Robin = BoundaryConditionType::bType_Robin

constexpr auto	iBC_Robin = static_cast<int>(BoundaryConditionType::bType_Robin)

constexpr auto	BC_std = BoundaryConditionType::bType_std

constexpr auto	iBC_std = static_cast<int>(BoundaryConditionType::bType_std)

constexpr auto	BC_symm = BoundaryConditionType::bType_symm

constexpr auto	iBC_symm = static_cast<int>(BoundaryConditionType::bType_symm)

constexpr auto	BC_trac = BoundaryConditionType::bType_trac

constexpr auto	iBC_trac = static_cast<int>(BoundaryConditionType::bType_trac)

constexpr auto	BC_undefNeu = BoundaryConditionType::bType_undefNeu

constexpr auto	iBC_undefNeu = static_cast<int>(BoundaryConditionType::bType_undefNeu)

constexpr auto	BC_ustd = BoundaryConditionType::bType_ustd

constexpr auto	iBC_ustd = static_cast<int>(BoundaryConditionType::bType_ustd)

constexpr auto	Equation_CMM = EquationType::phys_CMM

constexpr auto	Equation_CEP = EquationType::phys_CEP

constexpr auto	Equation_fluid = EquationType::phys_fluid

constexpr auto	Equation_FSI = EquationType::phys_FSI

constexpr auto	Equation_heatF = EquationType::phys_heatF

constexpr auto	Equation_heatS = EquationType::phys_heatS

constexpr auto	Equation_lElas = EquationType::phys_lElas

constexpr auto	Equation_mesh = EquationType::phys_mesh

constexpr auto	Equation_shell = EquationType::phys_shell

constexpr auto	Equation_stokes = EquationType::phys_stokes

constexpr auto	Equation_struct = EquationType::phys_struct

constexpr auto	Equation_ustruct = EquationType::phys_ustruct

Detailed Description

Copyright (c) Stanford University, The Regents of the University of California, and others.

See Copyright-SimVascular.txt for additional details.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Typedef Documentation

◆ PreconditionerMapType

using consts::PreconditionerMapType = typedef std::pair<PreconditionerType,bool>

Map for preconditioner type string to pair (PreconditionerType enum, bool(true if Trilinos precondition)).

Enumeration Type Documentation

◆ BodyForceType

enum consts::BodyForceType

strong

Body force types: volumetric (default), traction, Neumann (pressure based), time dependence (steady, unsteady, spatially varying, general)

◆ BoundaryConditionType

enum consts::BoundaryConditionType

strong

Boundary conditions type.

BC types are stored as bitwise values.

boundary conditions types. Items of this list can be combined

BCs from imposing perspective can be Neu/Dir/per
BCs time dependence can be std/ustd/cpl/gen/res
BCs spatial distribution can be flat/para/ud
Beside these nodes at the boundary perimeter can be set to zero and flux through surface can be assigned instead of nodal values.
Dirichlet, Neumann, Traction, CMM, Robin, steady, unsteady, coupled, general (combination of ud/ustd), resistance, imposed flux, zero out perimeter, impose BC on the integral of state variable or D (instead of Y), flat profile, parabolic profile, user defined profile, backflow stabilization, BCs for shells (fixed, hinged, free, symmetric), undeforming Neu, RCR-Neu

◆ CplBCType

enum consts::CplBCType

strong

Differenty type of coupling for cplBC.

    INTEGER(KIND=IKIND), PARAMETER :: cplBC_NA = 400, cplbc_i = 401,
    cplbc_si = 402, cplbc_e = 403
//
    INTEGER(KIND=IKIND), PARAMETER :: cplBC_Dir = 66112, cplbc_neu = 66113

◆ ElementType

enum consts::ElementType

strong

Element type replicating eType_NA, eType_PNT, etc.

◆ EquationType

enum consts::EquationType

strong

Types of equations that are included in this solver.

Fluid equation (Navier-Stokes), nonlinear structure (pure d), heat equation, linear elasticity, heat in fluid (advection-diffusion), fluid-structure-interaction, mesh motion, Shell mechanics, Coupled-Momentum-Method, Cardiac Electro-Physiology, Nonlinear structure (v-p), Stokes equations

◆ PhysicalProperyType

enum consts::PhysicalProperyType

strong

Possible physical properties. Current maxNPror is 20.

Function Documentation

◆ operator<<()

template<typename T >

std::ostream& consts::operator<<	(	typename std::enable_if< std::is_enum< T >::value, std::ostream >::type &	stream,
		const T &	e
	)

Template for printing enum class types as an int.

◆ present()

template<typename T >

bool consts::present ( T value )

Check if a value is set to infinity.

Variable Documentation

◆ constitutive_model_name_to_type

const std::map< std::string, ConstitutiveModelType > consts::constitutive_model_name_to_type

Map for constitutive_model string to ConstitutiveModelType.

Type of constitutive model (isochoric) for structure equation: St.Venant-Kirchhoff, modified St.Venant-Kirchhoff, NeoHookean, Mooney-Rivlin, modified Holzapfel-Gasser-Ogden with dispersion, Linear model (S = mu*I), Guccione (1995), Holzapfel & Ogden model

◆ contact_model_name_to_type

const std::map< std::string, ContactModelType > consts::contact_model_name_to_type

Initial value:

=
{
  {"penalty", ContactModelType::cntctM_penalty},
  {"potential", ContactModelType::cntctM_potential},
}

Map for contact model string name to ContacteModelType.

Map for model type string to ContactModelType.

◆ cplbc_name_to_type

const std::map< std::string, CplBCType > consts::cplbc_name_to_type

Initial value:

= {
    {"E", CplBCType::cplBC_E},
    {"I", CplBCType::cplBC_I},
    {"SI", CplBCType::cplBC_SI}
  }

Map for cplBC type to CplBCType.

◆ element_type_to_elem_nonb

const std::map< ElementType, int > consts::element_type_to_elem_nonb

Initial value:

= 
{
  {ElementType::LIN1,  1 },
  {ElementType::LIN2,  1 },
  {ElementType::TRI3,  2 },
  {ElementType::TRI6,  3 },
  {ElementType::QUD4,  2 },
  {ElementType::QUD8,  3 },
  {ElementType::QUD9,  3 },
  {ElementType::TET4,  3 },
  {ElementType::TET10, 6 },
  {ElementType::HEX8,  4 },
  {ElementType::HEX20, 8 },
  {ElementType::HEX27, 9 },
  {ElementType::WDG,   3 }
}

Reproduces the 'SELECT CASE (lMeType)' statements in the Fortran 'PARTMSH' subroutine.

◆ equation_name_to_type

const std::map< std::string, EquationType > consts::equation_name_to_type

Map equation name to a type.

◆ fluid_viscosity_model_name_to_type

const std::map< std::string, FluidViscosityModelType > consts::fluid_viscosity_model_name_to_type

Initial value:

{
  {"const", FluidViscosityModelType::viscType_Const},
  {"constant", FluidViscosityModelType::viscType_Const},
  {"newtonian", FluidViscosityModelType::viscType_Const},
 
  {"cy", FluidViscosityModelType::viscType_CY},
  {"carreau-yasuda", FluidViscosityModelType::viscType_CY},
 
  {"cass", FluidViscosityModelType::viscType_Cass},
  {"cassons", FluidViscosityModelType::viscType_Cass},
 
}

Map for fluid viscosity model string to FluidViscosityModelType.

◆ int_inf

const int consts::int_inf = std::numeric_limits<int>::infinity()

Use inf numeric values to represent a value that is not set.

◆ mesh_generator_name_to_type

const std::map< std::string, MeshGeneratorType > consts::mesh_generator_name_to_type

Initial value:

= {
    {"Tetgen", MeshGeneratorType::RMSH_TETGEN},
    {"Meshsim", MeshGeneratorType::RMSH_MESHSIM}
}

Map for string to MeshGeneratorType.

◆ preconditioner_name_to_type

const std::map< std::string, PreconditionerMapType > consts::preconditioner_name_to_type

Initial value:

=
{
  {"fsils", std::make_pair(PreconditionerType::PREC_FSILS,false)},
  {"svfsi", std::make_pair(PreconditionerType::PREC_FSILS,false)},
 
  {"rcs", std::make_pair(PreconditionerType::PREC_RCS,false)},
  {"row-column-scaling", std::make_pair(PreconditionerType::PREC_RCS,false)},
 
  {"trilinos-diagonal", std::make_pair(PreconditionerType::PREC_TRILINOS_DIAGONAL,true)},
 
  {"trilinos-blockjacobi", std::make_pair(PreconditionerType::PREC_TRILINOS_BLOCK_JACOBI,true)},
  {"blockjacobi", std::make_pair(PreconditionerType::PREC_TRILINOS_BLOCK_JACOBI,true)},
 
  {"trilinos-ilu", std::make_pair(PreconditionerType::PREC_TRILINOS_ILU,true)},
  {"trilinos-ilut", std::make_pair(PreconditionerType::PREC_TRILINOS_ILUT,true)},
 
  {"trilinos-ic", std::make_pair(PreconditionerType::PREC_TRILINOS_IC,true)},
  {"trilinos-ict", std::make_pair(PreconditionerType::PREC_TRILINOS_ICT,true)},
 
  {"trilinos-ml", std::make_pair(PreconditionerType::PREC_TRILINOS_ML,true)}
 
}

Map for preconditioner type string to PreconditionerType enum.

◆ solver_name_to_type

const std::map< std::string, SolverType > consts::solver_name_to_type

Initial value:

{
  {"bi-partitioned", SolverType::lSolver_NS},
  {"ns", SolverType::lSolver_NS},
  {"bpn", SolverType::lSolver_NS},
  {"bipn", SolverType::lSolver_NS},
 
  {"gmres", SolverType::lSolver_GMRES},
 
  {"conjugate-gradient", SolverType::lSolver_CG},
  {"cg", SolverType::lSolver_CG},
 
  {"bi-conjugate-gradient", SolverType::lSolver_BICGS},
  {"bicg", SolverType::lSolver_BICGS},
  {"bicgs", SolverType::lSolver_BICGS}
}

Map solver type string to SolverType enum.

Map for solver type string to SolverType enum.

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ PreconditionerMapType

Enumeration Type Documentation

◆ BodyForceType

◆ BoundaryConditionType

◆ CplBCType

◆ ElementType

◆ EquationType

◆ PhysicalProperyType

Function Documentation

◆ operator<<()

◆ present()

Variable Documentation

◆ constitutive_model_name_to_type

◆ contact_model_name_to_type

◆ cplbc_name_to_type

◆ element_type_to_elem_nonb

◆ equation_name_to_type

◆ fluid_viscosity_model_name_to_type

◆ int_inf

◆ mesh_generator_name_to_type

◆ preconditioner_name_to_type

◆ solver_name_to_type