FieldConstant< spacedim, Value > Class Template Reference

#include <field_constant.hh>

Inheritance diagram for FieldConstant< spacedim, Value >:

Collaboration diagram for FieldConstant< spacedim, Value >:

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

Public Member Functions
	FieldConstant (unsigned int n_comp=0)
FieldConstant< spacedim, Value > &	set_value (const typename Value::return_type &val)
virtual void	init_from_input (const Input::Record &rec)
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	~FieldConstant ()
Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
	FieldAlgorithmBase (unsigned int n_comp=0)
virtual bool	set_time (const TimeStep &time)
virtual void	set_mesh (const Mesh *mesh, bool boundary_domain)
void	set_component_idx (unsigned int idx)
unsigned int	n_comp () const
FieldResult	field_result () const
virtual double	next_change_time ()
virtual	~FieldAlgorithmBase ()

Static Public Member Functions
static Input::Type::Record	get_input_type (Input::Type::AbstractRecord &a_type, const typename Value::ElementInputType *eit)
Static Public Member Functions inherited from FieldAlgorithmBase< spacedim, Value >
static std::string	template_name ()
static Input::Type::AbstractRecord	get_input_type (const typename Value::ElementInputType *element_input_type=nullptr)
static std::shared_ptr < FieldAlgorithmBase< spacedim, Value > >	function_factory (const Input::AbstractRecord &rec, unsigned int n_comp=0)

Static Public Attributes
static Input::Type::Record	input_type = FieldConstant<spacedim, Value>::get_input_type(FieldAlgorithmBase<spacedim, Value>::input_type, NULL)
	Implementation. More...
Static Public Attributes inherited from FieldAlgorithmBase< spacedim, Value >
static const unsigned int	spacedim_ =spacedim
static Input::Type::AbstractRecord	input_type

Additional Inherited Members
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...

Detailed Description

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

Class representing spatially constant fields.

Definition at line 22 of file field_constant.hh.

Member Typedef Documentation

template<int spacedim, class Value>

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

Definition at line 25 of file field_constant.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value >

FieldConstant< spacedim, Value >::FieldConstant

(

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 47 of file field_constant.impl.hh.

template<int spacedim, class Value >

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

virtual

Definition at line 101 of file field_constant.impl.hh.

Member Function Documentation

template<int spacedim, class Value >

Input::Type::Record FieldConstant< spacedim, Value >::get_input_type ( Input::Type::AbstractRecord &  a_type, const typename Value::ElementInputType *  eit  )

static

Return Record for initialization of FieldConstant that is derived from AbstractRecord given by a_type and the individual elements of the possible Value (vector, tensor) have Input::Type eit.

Definition at line 25 of file field_constant.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >

void FieldConstant< spacedim, Value >::init_from_input ( const Input::Record &  rec )

virtual

This method initialize actual value of the field given from the given Input::Record rec.

Reimplemented from FieldAlgorithmBase< spacedim, Value >.

Definition at line 62 of file field_constant.impl.hh.

template<int spacedim, class Value >

FieldConstant< spacedim, Value > & FieldConstant< spacedim, Value >::set_value

(

const typename Value::return_type &

val

)

Smart setter from the given value to return.

Definition at line 53 of file field_constant.impl.hh.

template<int spacedim, class Value >

Value::return_type const & FieldConstant< 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 72 of file field_constant.impl.hh.

template<int spacedim, class Value >

void FieldConstant< 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 83 of file field_constant.impl.hh.

Member Data Documentation

template<int spacedim, class Value>

it::Record FieldConstant< spacedim, Value >::input_type = FieldConstant<spacedim, Value>::get_input_type(FieldAlgorithmBase<spacedim, Value>::input_type, NULL)

static

Implementation.

Definition at line 33 of file field_constant.hh.

---

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

• /home/builder/jenkins/F123-linux-release/flow123d/src/fields/field_constant.hh
• /home/builder/jenkins/F123-linux-release/flow123d/src/fields/field_constant.impl.hh