Prescription Class Reference

To prescribe various types of data by an algebraic expression. Data may consist in boundary conditions, forces, tractions, fluxes, initial condition. All these data types can be defined through an enumerated variable. More...

#include <Prescription.h>

Public Member Functions
	Prescription ()
	Default constructor.
	Prescription (Mesh &mesh, const std::string &file)
	Constructor that gives an instance of class Mesh and the data file name. More...
	~Prescription ()
	Destructor.
int	get (EqDataType type, Vect< real_t > &v, real_t time=0, size_t dof=0)
Vect< real_t > &	get (EqDataType type, real_t time=0, size_t dof=0)

Detailed Description

To prescribe various types of data by an algebraic expression. Data may consist in boundary conditions, forces, tractions, fluxes, initial condition. All these data types can be defined through an enumerated variable.

Author

Rachid Touzani

Copyright

GNU Lesser Public License

Constructor & Destructor Documentation

Prescription()

Prescription	(	Mesh &	mesh,
		const std::string &	file
	)

Constructor that gives an instance of class Mesh and the data file name.

It reads parameters in Prescription Format from this file.

Parameters

[in]	mesh	Mesh instance
[in]	file	Name of Prescription file

Member Function Documentation

get() [1/2]

Vect< real_t > & get	(	EqDataType	type,
		real_t	time = 0,
		size_t	dof = 0
	)

Read data in the given file and returns as a Vect instance for a chosen DOF. The input value type determines the type of data to read.

Parameters

[in]	type	Type of data to seek. To choose among the enumerated values: BOUNDARY_CONDITION: Read values for (Dirichlet) boundary conditions BOUNDARY_FORCE: Read values for boundary force (Neumann boundary condition). The values TRACTION and FLUX have the same effect. BODY_FORCE: Read values for body (or volume) forces. The value SOURCE has the same effect. POINT_FORCE: Read values for pointwise forces CONTACT_DISTANCE: Read values for contact distance (for contact mechanics) INITIAL_FIELD: Read values for initial solution SOLUTION: Read values for a solution vector
[in]	time	Value of time for which data is read [Default: 0].
[in]	dof	DOF to store (Default is 0: All DOFs are chosen).

get() [2/2]

int get	(	EqDataType	type,
		Vect< real_t > &	v,
		real_t	time = 0,
		size_t	dof = 0
	)

Read data in the given file and stores in a Vect instance for a chosen DOF. The input value type determines the type of data to read.

Parameters

[in]	type	Type of data to seek. To choose among the enumerated values: BOUNDARY_CONDITION: Read values for (Dirichlet) boundary conditions BOUNDARY_FORCE: Read values for boundary force (Neumann boundary condition). The values TRACTION and FLUX have the same effect. BODY_FORCE: Read values for body (or volume) forces. The value SOURCE has the same effect. POINT_FORCE: Read values for pointwise forces CONTACT_DISTANCE: Read values for contact distance (for contact mechanics) INITIAL_FIELD: Read values for initial solution SOLUTION: Read values for a solution vector
[in,out]	v	Vect instance that is instantiated on input and filled on output
[in]	time	Value of time for which data is read [Default: 0].
[in]	dof	DOF to store (Default is 0: All DOFs are chosen).