#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)

VectorMPI	set_fe_data (std::shared_ptr< DOFHandlerMultiDim > dh, unsigned int component_index=0, VectorMPI dof_values=VectorMPI::sequential(0))

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

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

void	cache_update (FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_idx) override

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	native_data_to_cache (ElementDataCache< double > &output_data_cache)

unsigned int	data_size () const

std::shared_ptr< DOFHandlerMultiDim >	get_dofhandler () const

VectorMPI &	vec ()

void	local_to_ghost_data_scatter_begin ()
	Call begin scatter functions (local to ghost) on data vector. More...

void	local_to_ghost_data_scatter_end ()
	Call end scatter functions (local to ghost) on data vector. More...

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 ()

virtual void	set_native_dh (std::shared_ptr< DOFHandlerMultiDim >)

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	calculate_identic_values (ElementDataCache< double >::ComponentDataPtr data_cache)
	Calculate data of identict_mesh interpolation on input data over all elements of target mesh. More...

void	calculate_equivalent_values (ElementDataCache< double >::ComponentDataPtr data_cache)
	Calculate data of equivalent_mesh interpolation on input over all elements of target mesh. More...

void	fill_boundary_dofs ()

template<unsigned int dim>
Quadrature	init_quad (std::shared_ptr< EvalPoints > eval_points)
	Initialize FEValues object of given dimension. More...

Armor::ArmaMat< typename Value::element_type, Value::NRows_, Value::NCols_ >	handle_fe_shape (unsigned int dim, unsigned int i_dof, unsigned int i_qp, unsigned int comp_index)

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

VectorMPI	data_vec_
	Store data of Field. 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...

MixedPtr< FiniteElement >	fe_

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< IntIdx > >	boundary_dofs_

std::vector< FEValues< spacedim > >	fe_values_
	List of FEValues objects of dimensions 0,1,2,3 used for value calculation. More...

std::shared_ptr< std::vector< LongIdx > >	source_target_mesh_elm_map_
	Maps element indices between source (data) and target (computational) mesh if data interpolation is set to equivalent_msh. More...

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 = std::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 60 of file field.hh.

Member Typedef Documentation

template<int spacedim, class Value>

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

Definition at line 53 of file field_fe.hh.

template<int spacedim, class Value>

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

Definition at line 52 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 58 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 132 of file field_fe.cc.

template<int spacedim, class Value >

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

virtual

Destructor.

Definition at line 871 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 >::cache_update	(	FieldValueCache< typename Value::element_type > &	data_cache,
		ElementCacheMap &	cache_map,
		unsigned int	region_idx
	)

overridevirtual

Overload FieldAlgorithmBase::cache_update

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 231 of file field_fe.cc.

template<int spacedim, class Value >

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

private

Calculate data of equivalent_mesh interpolation on input over all elements of target mesh.

Definition at line 754 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

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

private

Calculate data of identict_mesh interpolation on input data over all elements of target mesh.

Definition at line 709 of file field_fe.cc.

Here is the caller graph for this function:

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 679 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 835 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 341 of file field_fe.cc.

Here is the caller graph for this function:

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 91 of file field_fe.cc.

template<int spacedim, class Value>

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

inline

Definition at line 142 of file field_fe.hh.

Here is the caller graph for this function:

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 60 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 103 of file field_fe.cc.

template<int spacedim, class Value >

Armor::ArmaMat< typename Value::element_type, Value::NRows_, Value::NCols_ > FieldFE< spacedim, Value >::handle_fe_shape	(	unsigned int	dim,
		unsigned int	i_dof,
		unsigned int	i_qp,
		unsigned int	comp_index
	)

private

Definition at line 856 of file field_fe.cc.

Here is the caller graph for this function:

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 286 of file field_fe.cc.

template<int spacedim, class Value >

template<unsigned int dim>

Quadrature FieldFE< spacedim, Value >::init_quad ( std::shared_ptr< EvalPoints > eval_points )

private

Initialize FEValues object of given dimension.

Definition at line 276 of file field_fe.cc.

Here is the caller graph for this function:

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 473 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 568 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

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

Call begin scatter functions (local to ghost) on data vector.

Definition at line 842 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

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

Call end scatter functions (local to ghost) on data vector.

Definition at line 849 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 368 of file field_fe.cc.

Here is the caller graph for this function:

template<int spacedim, class Value >

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

Copy data vector to given output ElementDataCache

Definition at line 816 of file field_fe.cc.

template<int spacedim, class Value >

VectorMPI FieldFE< spacedim, Value >::set_fe_data	(	std::shared_ptr< DOFHandlerMultiDim >	dh,
		unsigned int	component_index = `0`,
		VectorMPI	dof_values = `VectorMPI::sequential(0)`
	)

Setter for the finite element data.

Parameters

dh	Dof handler.
data	Vector of dof values, optional (create own vector according to dofhandler).
component_index	Index of component (for vector_view/tensor_view)

Returns: Data vector of dof values.

Definition at line 141 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 309 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 416 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 180 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 Armor::array &	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 204 of file field_fe.cc.

template<int spacedim, class Value>

VectorMPI& FieldFE< spacedim, Value >::vec ( )

inline

Definition at line 146 of file field_fe.hh.

Here is the caller graph for this function:

Member Data Documentation

template<int spacedim, class Value>

std::shared_ptr< std::vector<IntIdx> > 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 243 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 236 of file field_fe.hh.

template<int spacedim, class Value>

VectorMPI FieldFE< spacedim, Value >::data_vec_

private

Store data of Field.

Definition at line 196 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 230 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 194 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 221 of file field_fe.hh.

template<int spacedim, class Value>

MixedPtr<FiniteElement> FieldFE< spacedim, Value >::fe_

private

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

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

Definition at line 212 of file field_fe.hh.

template<int spacedim, class Value>

std::vector<FEValues<spacedim> > FieldFE< spacedim, Value >::fe_values_

private

List of FEValues objects of dimensions 0,1,2,3 used for value calculation.

Definition at line 246 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 218 of file field_fe.hh.

template<int spacedim, class Value>

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

private

Field flags.

Definition at line 227 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 233 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 224 of file field_fe.hh.

template<int spacedim, class Value>

FilePath FieldFE< spacedim, Value >::reader_file_

private

mesh reader file

Definition at line 215 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 252 of file field_fe.hh.

template<int spacedim, class Value>

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

private

Maps element indices between source (data) and target (computational) mesh if data interpolation is set to equivalent_msh.

Definition at line 249 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 199 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 201 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 203 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 205 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 >