AModelConfig. More...

Detailed Description

AModelConfig.

Definition at line 18 of file AFEMConfig.m.

Public Member Functions
	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
	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 ()
	% 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

fem.AFEMConfig.AFEMConfig ( varargin )

Definition at line 82 of file AFEMConfig.m.

References addOption().

Here is the call graph for this function:

Member Function Documentation

function fem.AFEMConfig.addOption	(	name,
		default,
		varargin
	)

protected

Definition at line 219 of file AFEMConfig.m.

Referenced by models.muscle.tests.Activation.Activation(), AFEMConfig(), models.muscle.AMuscleConfig.AMuscleConfig(), models.muscle.examples.Debug.Debug(), models.muscle.examples.Long.Long(), models.muscle.examples.MuscleTendonMix.MuscleTendonMix(), models.muscle.tests.NeumannPressure.NeumannPressure(), models.muscle.examples.Shear.Shear(), models.muscle.examples.SubElemInhomogMaterial.SubElemInhomogMaterial(), and models.muscle.examples.ThinTendon.ThinTendon().

Here is the caller graph for this function:

function fem.AFEMConfig.configureModel ( models.BaseFullModel model )

Overload this method to set model-specific quantities like simulation time etc.

Parameters

model A KerMor full model

Definition at line 95 of file AFEMConfig.m.

References Model.

function fem.AFEMConfig.configureModelFinal ( )

Definition at line 107 of file AFEMConfig.m.

function [displ_dir , velo_dir , velo_dir_val ] = fem.AFEMConfig.getBC ( )

Definition at line 241 of file AFEMConfig.m.

References Geometry, setPositionDirichletBC(), and setVelocityDirichletBC().

Here is the call graph for this function:

function P = fem.AFEMConfig.getBoundaryPressure	(	elemidx,
		faceidx
	)

Determines the neumann forces on the boundary.

The unit for the applied quantities is megaPascal [MPa]

In the default implementation there are no force boundary conditions.

See Also: NeumannCoordinateSystem

Definition at line 127 of file AFEMConfig.m.

Referenced by getSpatialExternalForces().

Here is the caller graph for this function:

function geo = fem.AFEMConfig.getGeometry ( )

protectedpure virtual

Returns the intended geometry for this model config.

The options will be set at call time, e.g. "GeoNr" is already set.

Referenced by init().

Here is the caller graph for this function:

function str = fem.AFEMConfig.getOptionStr ( withtag )

Definition at line 145 of file AFEMConfig.m.

References handle.fieldnames, handle.fields, Utils.implode(), k, and Options.

Referenced by models.muscle.AExperimentModelConfig.getX0().

Here is the call graph for this function:

Here is the caller graph for this function:

function [force , nodeidx , faceswithforce ] = fem.AFEMConfig.getSpatialExternalForces ( )

Definition at line 255 of file AFEMConfig.m.

References FEM, getBoundaryPressure(), NeumannCoordinateSystem, and t.

Here is the call graph for this function:

function fem.AFEMConfig.init ( )

protected

% Parse the options

Definition at line 181 of file AFEMConfig.m.

References FEM, Geometry, getGeometry(), and Options.

Here is the call graph for this function:

function fem.AFEMConfig.plotGeometryInfo	(	allnode,
		elemnr
	)

Definition at line 166 of file AFEMConfig.m.

References FEM.

function fem.AFEMConfig.prepareSimulation	(	colvec< double >	mu,
		integer	inputidx
	)

Overload this method to initialize model-specific quantities that are fixed for each simulation.

Called by override of computeTrajectory in muscle.Model

Parameters

mu	The currently used parameter \(\vmu\). Set to \([]\) if not used.
inputidx	The index \(i\) of the currently used input function \(u_i(t)\). Set to \([]\) if not used.

Definition at line 111 of file AFEMConfig.m.

virtual function displ_dir = fem.AFEMConfig.setPositionDirichletBC ( displ_dir )

protectedpure virtual

Referenced by getBC().

Here is the caller graph for this function:

function [ velo_dir , velo_dir_val ] = fem.AFEMConfig.setVelocityDirichletBC	(	velo_dir,
		velo_dir_val
	)

protected

Determines the dirichlet velocities.

The unit for the applied quantities is [mm/ms] = [m/s]

In the default implementation there are no velocity conditions.

Definition at line 202 of file AFEMConfig.m.

Referenced by getBC().

Here is the caller graph for this function:

Member Data Documentation

fem.AFEMConfig.FEM

Definition at line 28 of file AFEMConfig.m.

fem.AFEMConfig.Geometry

Definition at line 31 of file AFEMConfig.m.

Referenced by models.muscle.AMuscleConfig.geta0(), getBC(), init(), and models.muscle.AMuscleConfig.init().

fem.AFEMConfig.Model

Definition at line 34 of file AFEMConfig.m.

Referenced by models.muscle.AExperimentModelConfig.computeInitialConditions(), configureModel(), models.muscle.examples.CubePull.configureModelFinal(), models.muscle.AMuscleConfig.configureModelFinal(), models.muscle.examples.Debug.configureModelFinal(), and models.muscle.examples.ThinTendon.getOutputOfInterest().

fem.AFEMConfig.NeumannCoordinateSystem = "local"

The coordinate system in which to interpret the applied pressure of neumann boundary conditions.

local uses the normals on the faces as given in the reference configuration, i.e. the "true" normals.

global uses the global coordinate system of the geometry, i.e. the master element. This can be used to apply forces coming from one fixed direction over a possibly noneven geometry surface.

Default: local

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

Definition at line 39 of file AFEMConfig.m.

Referenced by getSpatialExternalForces().

fem.AFEMConfig.Options

Definition at line 60 of file AFEMConfig.m.

fem.AFEMConfig.VelocityBCTimeFun

Velocity conditions application function.

Definition at line 65 of file AFEMConfig.m.

Referenced by models.muscle.examples.Debug.Debug(), models.muscle.examples.Shaker.Shaker(), models.muscle.examples.SubElemInhomogMaterial.SubElemInhomogMaterial(), and models.muscle.examples.ThinTendon.ThinTendon().

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

core/+fem/AFEMConfig.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation