Detailed Description

Definition at line 19 of file AMuscleConfig.m.

Public Member Functions
	AMuscleConfig (varargin)

function m =	createModel ()
	Convenience method. More...

function	configureModelFinal ()

function u =	getInputs ()
	Returns the inputs \(u(t)\) of the model. More...

function x0 =	getX0 (x0)
	do nothing More...

function	setForceLengthFun (f)
	Provided here only for convenient outside access. More...

function alpha =	getAlphaRamp (ramptime,double alphamax,double starttime)
	Creates a linearly increasing scalar function starting at starttime milliseconds ranging from zero to alphamax over ramptime. More...

function tmr =	getTendonMuscleRatio (unused1)
	Returns the [0,1] ratio between tendon and muscle at all gauss points of all elements. More...

function anull =	geta0 ()

Public Member Functions inherited from fem.AFEMConfig
	AFEMConfig (varargin)

function	configureModel (models.BaseFullModel model)
	Overload this method to set model-specific quantities like simulation time etc. More...

function	configureModelFinal ()

function	prepareSimulation (colvec< double > mu,integer inputidx)
	Overload this method to initialize model-specific quantities that are fixed for each simulation. More...

function P =	getBoundaryPressure (elemidx, faceidx)
	Determines the neumann forces on the boundary. More...

function str =	getOptionStr (withtag)

function	plotGeometryInfo (allnode, elemnr)

function [ displ_dir , velo_dir , velo_dir_val ] =	getBC ()

function [ force , nodeidx , faceswithforce ] =	getSpatialExternalForces ()

Public Attributes
	PressureFEM

	FibreTypeWeights = "[]"

	Pool

char	a0CoordinateSystem = "master"
	The coordinate system in which to interpret the a0 vectors of fibre directions. More...

double	ActivationRampMax = 1
	Determines the default value for maximum activation in activation ramps. More...

double	ActivationRampOffset = 0
	Determines the default number of milliseconds to wait before activation is started. More...

Public Attributes inherited from fem.AFEMConfig
	FEM

	Geometry

	Model

char	NeumannCoordinateSystem = "local"
	The coordinate system in which to interpret the applied pressure of neumann boundary conditions. More...

	Options

	VelocityBCTimeFun
	Velocity conditions application function. More...

Public Attributes inherited from handle
	addlistener
	Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...

	notify
	Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...

	delete
	Handle object destructor method that is called when the object's lifecycle ends. More...

	disp
	Handle object disp method which is called by the display method. See the MATLAB disp function. More...

	display
	Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...

	findobj
	Finds objects matching the specified conditions from the input array of handle objects. More...

	findprop
	Returns a meta.property objects associated with the specified property name. More...

	fields
	Returns a cell array of string containing the names of public properties. More...

	fieldnames
	Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...

	isvalid
	Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...

	eq
	Relational functions example. See details for more information. More...

	transpose
	Transposes the elements of the handle object array. More...

	permute
	Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...

	reshape
	hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...

	sort
	ort the handle objects in any array in ascending or descending order. More...

Protected Member Functions
function	init ()

function anull =	seta0 (anull)
	do nothing! More...

function ftw =	getFibreTypeWeights ()
	This is a lazy pre-implementation as fullmodels.muscle.Models always have fibre types and thus weights. More...

Protected Member Functions inherited from fem.AFEMConfig
function	init ()
	% Parse the options More...

function [ velo_dir , velo_dir_val ] =	setVelocityDirichletBC (velo_dir, velo_dir_val)
	Determines the dirichlet velocities. More...

function	addOption (name, default, varargin)

virtual function displ_dir =	setPositionDirichletBC (displ_dir)

virtual function geo =	getGeometry ()
	Returns the intended geometry for this model config. More...

Constructor & Destructor Documentation

models.muscle.AMuscleConfig.AMuscleConfig ( varargin )

Definition at line 102 of file AMuscleConfig.m.

References fem.AFEMConfig.addOption().

Here is the call graph for this function:

Member Function Documentation

function models.muscle.AMuscleConfig.configureModelFinal ( )

Definition at line 119 of file AMuscleConfig.m.

References fem.AFEMConfig.Model.

function m = models.muscle.AMuscleConfig.createModel ( )

Convenience method.

Definition at line 109 of file AMuscleConfig.m.

function anull = models.muscle.AMuscleConfig.geta0 ( )

Definition at line 321 of file AMuscleConfig.m.

References fem.AFEMConfig.FEM, fem.AFEMConfig.Geometry, Norm.L2(), and seta0().

Here is the call graph for this function:

function alpha = models.muscle.AMuscleConfig.getAlphaRamp	(		ramptime,
		double	alphamax,
		double	starttime
	)

Creates a linearly increasing scalar function starting at starttime milliseconds ranging from zero to alphamax over ramptime.

Parameters

ramptime	The time over which to increase to alphamax. If less or equal to zero, an all zero function is returned.
alphamax	The maximum value to achieve.

Default:: AMuscleConfig.ActivationRampMax

Parameters

starttime The offset time (in milliseconds) to wait before increasing the signal. Default: AMuscleConfig.ActivationRampOffset alpha = @(t)1;

Definition at line 224 of file AMuscleConfig.m.

References ActivationRampMax, and ActivationRampOffset.

Referenced by models.muscle.examples.LongForceBC.getInputs(), models.muscle.examples.Shear.getInputs(), models.muscle.examples.Cube2ForceBC.getInputs(), models.muscle.examples.ThinTendon.getInputs(), models.muscle.tests.NeumannPressure.getInputs(), models.muscle.examples.CubePull.getInputs(), models.muscle.examples.MuscleTendonMix.getInputs(), and models.muscle.examples.Debug.getInputs().

Here is the caller graph for this function:

function ftw = models.muscle.AMuscleConfig.getFibreTypeWeights ( )

protected

This is a lazy pre-implementation as fullmodels.muscle.Models always have fibre types and thus weights.

This method simply returns an all-zero weighting.

Definition at line 304 of file AMuscleConfig.m.

References fem.AFEMConfig.FEM.

function u = models.muscle.AMuscleConfig.getInputs ( )

Returns the inputs \(u(t)\) of the model.

if neumann boundary conditions are used, this input is multiplied with the mu(3) parameter, which determines the maximum force that is applied. u(t) determines its temporal strength.

this.Model can be used to get access to the model this configuration is applied to.

Default:: {}

Return values

u	The cell array of input functions to use within this model.

Definition at line 133 of file AMuscleConfig.m.

function tmr = models.muscle.AMuscleConfig.getTendonMuscleRatio ( unused1 )

Returns the [0,1] ratio between tendon and muscle at all gauss points of all elements.

This method simply returns an empty ratio, meaning muscle only.

Parameters

unused1	Marked as "~" in original m-file.
x	A 3xn vector of coordinates at which to get the tendonmuscle ratio

Return values

tmr	A row vector of tendonmuscle ratio values in [0 1] for each of the n locations

Definition at line 252 of file AMuscleConfig.m.

function x0 = models.muscle.AMuscleConfig.getX0 ( x0 )

do nothing

Definition at line 155 of file AMuscleConfig.m.

function models.muscle.AMuscleConfig.init ( )

protected

Definition at line 276 of file AMuscleConfig.m.

References fem.AFEMConfig.Geometry, and PressureFEM.

Here is the caller graph for this function:

function anull = models.muscle.AMuscleConfig.seta0 ( anull )

protected

do nothing!

Definition at line 294 of file AMuscleConfig.m.

Referenced by geta0().

Here is the caller graph for this function:

function models.muscle.AMuscleConfig.setForceLengthFun ( f )

Provided here only for convenient outside access.

The force-length function as function handle

This function describes the force-length relation for active force. There are currently three possibilites, exponential from [4],quadratic like in [5] or piecewise linear as in Gordon1966 .

Exponential Set to have one parameter: Width. The ascending part of the force-length fun is assumed to be steeper (Gordon1966 ), so the width is set to a proportion of the parameter on that side.

Required fields of f:

Definition at line 165 of file AMuscleConfig.m.

References fem.AFEMConfig.Options.

Member Data Documentation

models.muscle.AMuscleConfig.a0CoordinateSystem = "master"

The coordinate system in which to interpret the a0 vectors of fibre directions.

master applies the given directions at the master element coordinate system and transforms the directions according to the transformation of the respective element.

reference applies the given directions with respect to the reference coordinate system, e.g. "as-is" at the gauss points.

Default: master

Note: This property has non-standard access specifiers: SetAccess = Protected, GetAccess = Public; Matlab documentation of property attributes.

Definition at line 40 of file AMuscleConfig.m.

Referenced by models.muscle.examples.FibreDirections.FibreDirections().

models.muscle.AMuscleConfig.ActivationRampMax = 1

Determines the default value for maximum activation in activation ramps.

This is e.g. implicitly used by models.muscle.Dynamics.prepareSimulation, when the alpha ramp is created for positive mu(2) values (=ramp times).

Default: 1

Definition at line 63 of file AMuscleConfig.m.

Referenced by getAlphaRamp(), and models.muscle.examples.LongForceBC.LongForceBC().

models.muscle.AMuscleConfig.ActivationRampOffset = 0

Determines the default number of milliseconds to wait before activation is started.

This is e.g. implicitly used by models.muscle.Dynamics.prepareSimulation, when the alpha ramp is created for positive mu(2) values (=ramp times).

Default: 0

Definition at line 78 of file AMuscleConfig.m.

Referenced by getAlphaRamp().

models.muscle.AMuscleConfig.FibreTypeWeights = "[]"

Definition at line 34 of file AMuscleConfig.m.

Referenced by models.muscle.examples.Belly.Belly(), and models.muscle.examples.Debug.configureModel().

models.muscle.AMuscleConfig.Pool

Definition at line 37 of file AMuscleConfig.m.

Referenced by models.muscle.examples.Belly.Belly(), and models.muscle.examples.Debug.configureModel().

models.muscle.AMuscleConfig.PressureFEM

Definition at line 29 of file AMuscleConfig.m.

Referenced by init().

The documentation for this class was generated from the following file:

+models/+muscle/AMuscleConfig.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation