#include <field.hh>

Inheritance diagram for FieldFE< spacedim, Value >:

Collaboration diagram for FieldFE< spacedim, Value >:

[legend]

Public Types
enum	DataInterpolation { identic_msh, equivalent_msh, gauss_p0, interp_p0 }

typedef FieldAlgorithmBase< spacedim, Value >::Point	Point

typedef FieldAlgorithmBase< spacedim, Value >	FactoryBaseType

Public Types inherited from FieldAlgorithmBase< spacedim, Value >
typedef Space< spacedim >::Point	Point

Public Member Functions
	FieldFE (unsigned int n_comp=0)

void	set_fe_data (std::shared_ptr< DOFHandlerMultiDim > dh, MappingP1< 1, 3 > map1, MappingP1< 2, 3 > map2, MappingP1< 3, 3 > map3, VectorMPI data)

void	set_native_dh (std::shared_ptr< DOFHandlerMultiDim > dh) override

virtual Value::return_type const &	value (const Point &p, const ElementAccessor< spacedim > &elm)

virtual void	value_list (const std::vector< Point > &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list)

virtual void	init_from_input (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)

bool	set_time (const TimeStep &time) override

void	set_mesh (const Mesh *mesh, bool boundary_domain) override

void	fill_data_to_cache (ElementDataCache< double > &output_data_cache)

unsigned int	data_size () const

std::shared_ptr< DOFHandlerMultiDim >	get_dofhandler () const

VectorMPI *	get_data_vec () const

virtual	~FieldFE ()
	Destructor. More...

Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
	FieldAlgorithmBase (unsigned int n_comp=0)

void	set_component_idx (unsigned int idx)

unsigned int	n_comp () const

FieldResult	field_result () const

virtual double	next_change_time ()

bool	is_constant_in_space () const

virtual	~FieldAlgorithmBase ()

Static Public Member Functions
static const Input::Type::Record &	get_input_type ()
	Implementation. More...

static const Input::Type::Selection &	get_disc_selection_input_type ()

static const Input::Type::Selection &	get_interp_selection_input_type ()

Static Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
static std::string	template_name ()

static Input::Type::Abstract &	get_input_type ()

static const Input::Type::Instance &	get_input_type_instance (Input::Type::Selection value_selection=Input::Type::Selection())

static const Input::Type::Record &	get_field_algo_common_keys ()

static std::shared_ptr< FieldAlgorithmBase< spacedim, Value > >	function_factory (const Input::AbstractRecord &rec, const struct FieldAlgoBaseInitData &init_data)

Private Member Functions
void	make_dof_handler (const Mesh *mesh)
	Create DofHandler object. More...

void	interpolate_gauss (ElementDataCache< double >::ComponentDataPtr data_vec)
	Interpolate data (use Gaussian distribution) over all elements of target mesh. More...

void	interpolate_intersection (ElementDataCache< double >::ComponentDataPtr data_vec)
	Interpolate data (use intersection library) over all elements of target mesh. More...

void	calculate_native_values (ElementDataCache< double >::ComponentDataPtr data_cache)
	Calculate native data over all elements of target mesh. More...

void	reinit_fe_data (MappingP1< 1, 3 > map1, MappingP1< 2, 3 > map2, MappingP1< 3, 3 > *map3)
	Ensure data setting of methods set_fe_data and set_native_dh. More...

void	fill_boundary_dofs ()

Private Attributes
std::shared_ptr< DOFHandlerMultiDim >	dh_
	DOF handler object. More...

VectorMPI *	data_vec_
	Store data of Field. More...

std::vector< LongIdx >	dof_indices_
	Array of indexes to data_vec_, used for get/set values. More...

FEValueHandler< 0, spacedim, Value >	value_handler0_
	Value handler that allows get value of 0D elements. More...

FEValueHandler< 1, spacedim, Value >	value_handler1_
	Value handler that allows get value of 1D elements. More...

FEValueHandler< 2, spacedim, Value >	value_handler2_
	Value handler that allows get value of 2D elements. More...

FEValueHandler< 3, spacedim, Value >	value_handler3_
	Value handler that allows get value of 3D elements. More...

FiniteElement< 0 > *	fe0_

FiniteElement< 1 > *	fe1_
	Same as previous, but represents 1D element. More...

FiniteElement< 2 > *	fe2_
	Same as previous, but represents 2D element. More...

FiniteElement< 3 > *	fe3_
	Same as previous, but represents 3D element. More...

FilePath	reader_file_
	mesh reader file More...

std::string	field_name_
	field name read from input More...

OutputTime::DiscreteSpace	discretization_
	Specify section where to find the field data in input mesh file. More...

DataInterpolation	interpolation_
	Specify type of FE data interpolation. More...

FieldFlag::Flags	flags_
	Field flags. More...

double	default_value_
	Default value of element if not set in mesh data file. More...

Input::Record	in_rec_
	Accessor to Input::Record. More...

bool	boundary_domain_
	Is set in set_mesh method. Value true means, that we accept only boundary element accessors in the `value` method. More...

std::shared_ptr< std::vector< LongIdx > >	boundary_dofs_

Static Private Attributes
static const int	registrar
	Registrar of class to factory. More...

Additional Inherited Members
Static Public Attributes inherited from FieldAlgorithmBase< spacedim, Value >
static const unsigned int	spacedim_ =spacedim

static constexpr bool	is_enum_valued = boost::is_same<typename Value::element_type, FieldEnum>::value

Protected Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
void	init_unit_conversion_coefficient (const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
	Init value of `unit_conversion_coefficient_` from input. More...

Protected Attributes inherited from FieldAlgorithmBase< spacedim, Value >
TimeStep	time_
	Actual time level; initial value is -infinity. More...

Value	value_
	Last value, prevents passing large values (vectors) by value. More...

Value::return_type	r_value_

FieldResult	field_result_
	Indicator of particular values (zero, one) constant over space. More...

unsigned int	component_idx_
	Specify if the field is part of a MultiField and which component it is. More...

double	unit_conversion_coefficient_
	Coeficient of conversion of user-defined unit. More...

bool	is_constant_in_space_
	Flag detects that field is only dependent on time. More...

Detailed Description

template<int spacedim, class Value>
class FieldFE< spacedim, Value >

Class representing fields given by finite element approximation.

Definition at line 56 of file field.hh.

Member Typedef Documentation

template<int spacedim, class Value >

typedef FieldAlgorithmBase<spacedim, Value> FieldFE< spacedim, Value >::FactoryBaseType

Definition at line 54 of file field_fe.hh.

template<int spacedim, class Value >

typedef FieldAlgorithmBase<spacedim, Value>::Point FieldFE< spacedim, Value >::Point

Definition at line 53 of file field_fe.hh.

Member Enumeration Documentation

template<int spacedim, class Value >

enum FieldFE::DataInterpolation

Possible interpolations of input data.

Enumerator
identic_msh	identical mesh
equivalent_msh	equivalent mesh (default value)
gauss_p0	P0 interpolation (with the use of Gaussian distribution)
interp_p0	P0 interpolation (with the use of calculation of intersections)

Definition at line 59 of file field_fe.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value >

FieldFE< spacedim, Value >::FieldFE ( unsigned int n_comp = 0 )

Default constructor, optionally we need number of components n_comp in the case of Vector valued fields.

Definition at line 127 of file field_fe.cc.

template<int spacedim, class Value >

FieldFE< spacedim, Value >::~FieldFE ( )

virtual

Destructor.

Definition at line 713 of file field_fe.cc.

Here is the caller graph for this function:

Member Function Documentation

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::calculate_native_values ( ElementDataCache< double >::ComponentDataPtr data_cache )

private

Calculate native data over all elements of target mesh.

Definition at line 646 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

unsigned int FieldFE< spacedim, Value >::data_size ( ) const

inline

Return size of vector of data stored in Field

Definition at line 706 of file field_fe.cc.

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::fill_boundary_dofs ( )

private

Fill data to boundary_dofs_ vector.

TODO: Temporary solution. Fix problem with merge new DOF handler and boundary Mesh. Will be removed in future.

Definition at line 307 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::fill_data_to_cache ( ElementDataCache< double > & output_data_cache )

Copy data vector to given output ElementDataCache

Definition at line 686 of file field_fe.cc.

template<int spacedim, class Value >

VectorMPI* FieldFE< spacedim, Value >::get_data_vec ( ) const

inline

Definition at line 153 of file field_fe.hh.

template<int spacedim, class Value >

const Input::Type::Selection & FieldFE< spacedim, Value >::get_disc_selection_input_type ( )

static

Return Input selection for discretization type (determines the section of VTK file).

Definition at line 86 of file field_fe.cc.

template<int spacedim, class Value >

std::shared_ptr<DOFHandlerMultiDim> FieldFE< spacedim, Value >::get_dofhandler ( ) const

inline

Definition at line 149 of file field_fe.hh.

template<int spacedim, class Value >

const Input::Type::Record & FieldFE< spacedim, Value >::get_input_type ( )

static

Implementation.

Return Record for initialization of FieldFE that is derived from Abstract

Definition at line 55 of file field_fe.cc.

template<int spacedim, class Value >

const Input::Type::Selection & FieldFE< spacedim, Value >::get_interp_selection_input_type ( )

static

Return Input selection that allow to set interpolation of input data.

Definition at line 98 of file field_fe.cc.

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::init_from_input	(	const Input::Record &	rec,
		const struct FieldAlgoBaseInitData &	init_data
	)

virtual

Initialization from the input interface.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 243 of file field_fe.cc.

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::interpolate_gauss ( ElementDataCache< double >::ComponentDataPtr data_vec )

private

Interpolate data (use Gaussian distribution) over all elements of target mesh.

Definition at line 447 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::interpolate_intersection ( ElementDataCache< double >::ComponentDataPtr data_vec )

private

Interpolate data (use intersection library) over all elements of target mesh.

Definition at line 541 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::make_dof_handler ( const Mesh * mesh )

private

Create DofHandler object.

Definition at line 334 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::reinit_fe_data	(	MappingP1< 1, 3 > *	map1,
		MappingP1< 2, 3 > *	map2,
		MappingP1< 3, 3 > *	map3
	)

private

Ensure data setting of methods set_fe_data and set_native_dh.

Definition at line 160 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::set_fe_data	(	std::shared_ptr< DOFHandlerMultiDim >	dh,
		MappingP1< 1, 3 > *	map1,
		MappingP1< 2, 3 > *	map2,
		MappingP1< 3, 3 > *	map3,
		VectorMPI *	data
	)

Setter for the finite element data. The mappings are required for computation of local coordinates.

Parameters

dh	Dof handler.
map1	1D mapping.
map2	2D mapping.
map3	3D mapping.
data	Vector of dof values.

Definition at line 137 of file field_fe.cc.

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::set_mesh	(	const Mesh *	mesh,
		bool	boundary_domain
	)

overridevirtual

Set target mesh.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 266 of file field_fe.cc.

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::set_native_dh ( std::shared_ptr< DOFHandlerMultiDim > dh )

overridevirtual

Postponed setter of Dof handler.

Allow to set native Dof handler after set_mesh.

Parameters

dh	Dof handler.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 151 of file field_fe.cc.

template<int spacedim, class Value >

bool FieldFE< spacedim, Value >::set_time ( const TimeStep & time )

overridevirtual

Update time and possibly update data from GMSH file.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 397 of file field_fe.cc.

template<int spacedim, class Value >

Value::return_type const & FieldFE< spacedim, Value >::value	(	const Point &	p,
		const ElementAccessor< spacedim > &	elm
	)

virtual

Returns one value in one given point. ResultType can be used to avoid some costly calculation if the result is trivial.

Implements FieldAlgorithmBase< spacedim, Value >.

Definition at line 193 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldFE< spacedim, Value >::value_list	(	const std::vector< Point > &	point_list,
		const ElementAccessor< spacedim > &	elm,
		std::vector< typename Value::return_type > &	value_list
	)

virtual

Returns std::vector of scalar values in several points at once.

Implements FieldAlgorithmBase< spacedim, Value >.

Definition at line 217 of file field_fe.cc.

Member Data Documentation

template<int spacedim, class Value >

std::shared_ptr< std::vector<LongIdx> > FieldFE< spacedim, Value >::boundary_dofs_

private

Hold dofs of boundary elements.

TODO: Temporary solution. Fix problem with merge new DOF handler and boundary Mesh. Will be removed in future.

Definition at line 245 of file field_fe.hh.

template<int spacedim, class Value >

bool FieldFE< spacedim, Value >::boundary_domain_

private

Is set in set_mesh method. Value true means, that we accept only boundary element accessors in the value method.

Definition at line 238 of file field_fe.hh.

template<int spacedim, class Value >

VectorMPI* FieldFE< spacedim, Value >::data_vec_

private

Store data of Field.

Definition at line 190 of file field_fe.hh.

template<int spacedim, class Value >

double FieldFE< spacedim, Value >::default_value_

private

Default value of element if not set in mesh data file.

Definition at line 232 of file field_fe.hh.

template<int spacedim, class Value >

std::shared_ptr<DOFHandlerMultiDim> FieldFE< spacedim, Value >::dh_

private

DOF handler object.

Definition at line 188 of file field_fe.hh.

template<int spacedim, class Value >

OutputTime::DiscreteSpace FieldFE< spacedim, Value >::discretization_

private

Specify section where to find the field data in input mesh file.

Definition at line 223 of file field_fe.hh.

template<int spacedim, class Value >

std::vector<LongIdx> FieldFE< spacedim, Value >::dof_indices_

private

Array of indexes to data_vec_, used for get/set values.

Definition at line 192 of file field_fe.hh.

template<int spacedim, class Value >

FiniteElement<0>* FieldFE< spacedim, Value >::fe0_

private

Used in DOFHandler::distribute_dofs method. Represents 0D element.

For correct functionality must be created proper descendant of FiniteElement class.

Definition at line 208 of file field_fe.hh.

template<int spacedim, class Value >

FiniteElement<1>* FieldFE< spacedim, Value >::fe1_

private

Same as previous, but represents 1D element.

Definition at line 210 of file field_fe.hh.

template<int spacedim, class Value >

FiniteElement<2>* FieldFE< spacedim, Value >::fe2_

private

Same as previous, but represents 2D element.

Definition at line 212 of file field_fe.hh.

template<int spacedim, class Value >

FiniteElement<3>* FieldFE< spacedim, Value >::fe3_

private

Same as previous, but represents 3D element.

Definition at line 214 of file field_fe.hh.

template<int spacedim, class Value >

std::string FieldFE< spacedim, Value >::field_name_

private

field name read from input

Definition at line 220 of file field_fe.hh.

template<int spacedim, class Value >

FieldFlag::Flags FieldFE< spacedim, Value >::flags_

private

Field flags.

Definition at line 229 of file field_fe.hh.

template<int spacedim, class Value >

Input::Record FieldFE< spacedim, Value >::in_rec_

private

Accessor to Input::Record.

Definition at line 235 of file field_fe.hh.

template<int spacedim, class Value >

DataInterpolation FieldFE< spacedim, Value >::interpolation_

private

Specify type of FE data interpolation.

Definition at line 226 of file field_fe.hh.

template<int spacedim, class Value >

FilePath FieldFE< spacedim, Value >::reader_file_

private

mesh reader file

Definition at line 217 of file field_fe.hh.

template<int spacedim, class Value >

const int FieldFE< spacedim, Value >::registrar

staticprivate

Initial value:

=
        Input::register_class< FieldFE<spacedim, Value>, unsigned int >("FieldFE") +
        FieldFE<spacedim, Value>::get_input_type().size()

Registrar of class to factory.

Definition at line 248 of file field_fe.hh.

template<int spacedim, class Value >

FEValueHandler<0, spacedim, Value> FieldFE< spacedim, Value >::value_handler0_

private

Value handler that allows get value of 0D elements.

Definition at line 195 of file field_fe.hh.

template<int spacedim, class Value >

FEValueHandler<1, spacedim, Value> FieldFE< spacedim, Value >::value_handler1_

private

Value handler that allows get value of 1D elements.

Definition at line 197 of file field_fe.hh.

template<int spacedim, class Value >

FEValueHandler<2, spacedim, Value> FieldFE< spacedim, Value >::value_handler2_

private

Value handler that allows get value of 2D elements.

Definition at line 199 of file field_fe.hh.

template<int spacedim, class Value >

FEValueHandler<3, spacedim, Value> FieldFE< spacedim, Value >::value_handler3_

private

Value handler that allows get value of 3D elements.

Definition at line 201 of file field_fe.hh.

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

/opt/flow123d/flow123d/src/fields/field.hh
/opt/flow123d/flow123d/src/fields/field_fe.hh
/opt/flow123d/flow123d/src/fields/field_fe.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

template<int spacedim, class Value> class FieldFE< spacedim, Value >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<int spacedim, class Value>
class FieldFE< spacedim, Value >